update flags to be more easily usable

This commit is contained in:
nytpu
2021-03-18 10:53:51 -06:00
parent c145f8d4d2
commit b0cbb4e380
2 changed files with 12 additions and 14 deletions
+8 -8
View File
@@ -56,9 +56,9 @@ command-specific flags that are not universally recognized.
## ADD FLAGS
*-t* _TYPE_, *--type* _TYPE_
Select which type a subscription is. Can be *g* for a Gemini feed; *a* for
Atom, RSS, & JSON; or *c* to watch the page for changes. Defaults to *g*.
*-w*, *--watch*
Watch a page for changes instead of adding as a feed. Useful for gophermaps,
or gemini/http resources with no parseable feed.
# ENVIRONMENT VARIABLES
@@ -96,19 +96,19 @@ Within the data directory, the following files are used:
# EXAMPLES
This will add a new Gemini feed subscripton:
This will add a new feed subscripton:
```
comitium add gemini://nytpu.com/gemlog/
```
This will add a new atom subscription:
This will add a new subscription over http:
```
comitium add -t a gemini://nytpu.com/flightlog/atom.xml
comitium add -t a https://www.nytpu.com/files/atom.xml
```
This will add a new subscription to watch for changes:
```
comitium add --type a gemini://nytpu.com/photos/by-date.gmi nytpu's photos
comitium add --watch gemini://nytpu.com/photos/by-date.gmi nytpu's photos
```
Note that when watching a page for changes, you should manually add a title,
otherwise the URL will be used.
@@ -127,7 +127,7 @@ For more information, see the README at <https://git.nytpu.com/comitium/about/>
or in your local copy of the repository.
For a tutorial, see the docs at <https://git.nytpu.com/comitium/tree/doc/> or in
your local repository.
*docs/* in your local repository.
# AUTHOR