Skip to content

Commit 9351239

Browse files
committed
Update README
1 parent 3a6edd0 commit 9351239

File tree

2 files changed

+46
-11
lines changed

2 files changed

+46
-11
lines changed

README.e.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ brew install devopsdays/tap/devopsdays-cli
3333

3434
# Usage
3535

36-
#### $ {{exec "devopsdays-cli" "--help" | color "sh"}}
36+
#### $ {{exec "devopsdays-cli" | color "sh"}}
37+
38+
#### $ {{exec "devopsdays-cli" "create" "speaker" "--help"| color "sh"}}
3739

3840
# History
3941

README.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Command-line utilities for the [devopsdays](https://www.devopsdays.org) website
1313
- [homebrew](#homebrew)
1414
- [via Go](#via-go)
1515
- [Usage](#usage)
16-
- [$ devopsdays-cli --help](#-devopsdays-cli---help)
16+
- [$ devopsdays-cli](#-devopsdays-cli)
1717
- [History](#history)
1818
- [How to release](#how-to-release)
1919
- [Tools needed for release](#tools-needed-for-release)
@@ -42,8 +42,15 @@ go get github.com/devopsdays/devopsdays-cli
4242

4343
# Usage
4444

45-
#### $ devopsdays-cli --help
45+
#### $ devopsdays-cli
4646
```sh
47+
_ _ _ _
48+
__| | _____ _____ _ __ ___ __| | __ _ _ _ ___ ___| (_)
49+
/ _` |/ _ \ \ / / _ \| '_ \/ __|/ _` |/ _` | | | / __|_____ / __| | |
50+
| (_| | __/\ V / (_) | |_) \__ \ (_| | (_| | |_| \__ \_____| (__| | |
51+
\__,_|\___| \_/ \___/| .__/|___/\__,_|\__,_|\__, |___/ \___|_|_|
52+
|_| |___/
53+
4754
Command-line utilities for the devopsdays.org website
4855
built with love by mattstratton in Go.
4956
@@ -53,21 +60,47 @@ Usage:
5360
devopsdays-cli [command]
5461
5562
Available Commands:
56-
add Add a thing to another thing
57-
create Make a new thing
58-
edit Edit an existing thing
63+
add Add items to talks, programs, or events
64+
create Create a new event, organizer, program, speaker, sponsor, or talk
65+
edit Edit an existing item
5966
help Help about any command
60-
remove Remove a thing to another thing
61-
show Show details about a thing
67+
remove Remove items from an event, a talk, or a program
68+
show Show details about various items
6269
6370
Flags:
64-
-c, --city string city name
65-
-h, --help help for devopsdays-cli
66-
-y, --year string year
71+
-d, --debug enable debug mode
72+
-h, --help help for devopsdays-cli
6773
6874
Use "devopsdays-cli [command] --help" for more information about a command.
6975
```
7076
77+
#### $ devopsdays-cli create speaker --help
78+
```sh
79+
_ _ _ _
80+
__| | _____ _____ _ __ ___ __| | __ _ _ _ ___ ___| (_)
81+
/ _` |/ _ \ \ / / _ \| '_ \/ __|/ _` |/ _` | | | / __|_____ / __| | |
82+
| (_| | __/\ V / (_) | |_) \__ \ (_| | (_| | |_| \__ \_____| (__| | |
83+
\__,_|\___| \_/ \___/| .__/|___/\__,_|\__,_|\__, |___/ \___|_|_|
84+
|_| |___/
85+
Creates a new speaker for an event.
86+
87+
Usage:
88+
devopsdays-cli create speaker [flags]
89+
90+
Examples:
91+
devopsdays-cli create speaker
92+
devopsdays-cli create speaker --city new-york
93+
devopsdays-cli create speaker -c "New York" --year "2017"
94+
95+
Flags:
96+
-c, --city string city to use
97+
-h, --help help for speaker
98+
-y, --year string year to use
99+
100+
Global Flags:
101+
-d, --debug enable debug mode
102+
```
103+
71104
# History
72105
73106
[CHANGELOG](CHANGELOG.md)

0 commit comments

Comments
 (0)