Cleaned up and clarified documentation
This commit is contained in:
+12
-3
@@ -54,6 +54,14 @@ command-specific flags that are not universally recognized.
|
||||
*-d* _PATH_, *--data* _PATH_
|
||||
Set the data directory where *comitium* will store its files.
|
||||
|
||||
## REFRESH FLAGS
|
||||
|
||||
*-n* _NUM_, *--num-workers* _NUM_
|
||||
Number of worker threads to use when refreshing feeds. More is faster, but
|
||||
there are more concurrent outgoing requests then, which can be not nice to
|
||||
the servers you're hitting and to other people on your network. Defaults to
|
||||
5.
|
||||
|
||||
## ADD FLAGS
|
||||
|
||||
*-w*, *--watch*
|
||||
@@ -103,7 +111,7 @@ comitium add gemini://nytpu.com/gemlog/
|
||||
|
||||
This will add a new subscription over http:
|
||||
```
|
||||
comitium add -t a https://www.nytpu.com/files/atom.xml
|
||||
comitium add https://www.nytpu.com/files/atom.xml
|
||||
```
|
||||
|
||||
This will add a new subscription to watch for changes:
|
||||
@@ -126,8 +134,9 @@ instance if you want to separate different topics into their own feeds.
|
||||
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
|
||||
*docs/* in your local repository.
|
||||
For a tutorial, see the quickstart at
|
||||
<https://git.nytpu.com/comitium/tree/doc/quickstart.md> or in *docs/* in your
|
||||
local repository.
|
||||
|
||||
# AUTHOR
|
||||
|
||||
|
||||
Reference in New Issue
Block a user