Skip to content

Commit e356762

Browse files
committed
docs: Update README
1 parent bed5c93 commit e356762

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,25 @@ You can use variables (`<param>` or `<param=default_value>` ) in snippets.
7171
- Edit snippets easily (config is just a TOML file).
7272
- Sync snippets via Gist or GitLab Snippets automatically.
7373

74+
# Creating a snippet
75+
76+
You can create a snippet by running `pet new`.
77+
78+
```
79+
$ pet new
80+
Command> echo Hello world!
81+
Description> print Hello world
82+
```
83+
84+
To see all available arguments, run `pet new --help`.
85+
86+
Multiline commands can be entered by using the multiline argument `pet new --multiline`
87+
88+
You can use also use variables in snippets, these are called parameters. More information on that in the next section.
89+
90+
You can also *tag* snippets to search for them faster. More information on that in the tag section.
91+
92+
7493
# Parameters
7594
There are `<n_ways>` ways of entering parameters.
7695

@@ -176,12 +195,11 @@ You can share snippets via Gist.
176195
# Usage
177196

178197
```
179-
pet - Simple command-line snippet manager.
180-
181198
Usage:
182199
pet [command]
183200
184201
Available Commands:
202+
clip Copy the selected commands
185203
configure Edit config file
186204
edit Edit snippet file
187205
exec Run the selected commands
@@ -195,6 +213,7 @@ Available Commands:
195213
Flags:
196214
--config string config file (default is $HOME/.config/pet/config.toml)
197215
--debug debug mode
216+
-h, --help help for pet
198217
199218
Use "pet [command] --help" for more information about a command.
200219
```

0 commit comments

Comments
 (0)