joeac/comitium
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cleanup docs

Browse Source
This commit is contained in:
nytpu
2021-03-19 17:52:00 -06:00
parent 5a4d499d81
commit 7c45ad1f06
2 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -20,10 +20,10 @@ output into a simple static Gemini document that you can put anywhere.
There are many Gemini aggregators out there, and yet not one does everything I There are many Gemini aggregators out there, and yet not one does everything I
want it to. I want an aggregator that: want it to. I want an aggregator that:
1. Works with Gemini and Gopher (and possibly http) 1. Works with Gemini *and* Gopher (and possibly http)
2. Supports Atom, RSS, and Gemini feeds (and possibly JSON feeds) 2. Supports Atom, RSS, and Gemini feeds (and possibly JSON feeds)
3. Can watch a page for changes 3. Can watch a page for changes
4. Simple usage that doesn't get all tangled with my bookmarks 4. Simple usage that doesn't get all tangled with my non-subscription bookmarks
(\*cough\**Lagrange*\*cough\*) (\*cough\**Lagrange*\*cough\*)
All of the aggregators always have really cool and unique features, and yet all All of the aggregators always have really cool and unique features, and yet all
@@ -32,7 +32,7 @@ going and writing my own.
Also, it's nice if it doesn't tie me to a specific browser/service; i.e. Also, it's nice if it doesn't tie me to a specific browser/service; i.e.
trivially self-hostable, ideally as CGI or static pages that can use an existing trivially self-hostable, ideally as CGI or static pages that can use an existing
server setup. server setup rather than needing vhosting and routes.
## usage ## usage
doc/comitium.1.scd
+4 -3
View File
@@ -49,7 +49,8 @@ command-specific flags that are not universally recognized.
## GLOBAL FLAGS ## GLOBAL FLAGS
*-d* _PATH_, *--data* _PATH_ *-d* _PATH_, *--data* _PATH_
Set the data directory where *comitium* will store its files. Set the data directory where comitium will store its files. See *FILES AND
DIRECTORIES* for more information.
## REFRESH FLAGS ## REFRESH FLAGS
@@ -91,7 +92,7 @@ Within the data directory, the following files are used:
*comitium.json* *comitium.json*
A json file listing all of the feeds, their titles, their subscription A json file listing all of the feeds, their titles, their subscription
type, and subscription-type–specific information. If you need to modify a type, and subscription-type-specific information. If you need to modify a
subscription (change its title, update a link, etc) it should be trivial to subscription (change its title, update a link, etc) it should be trivial to
manually edit. manually edit.
@@ -117,7 +118,7 @@ comitium add https://www.nytpu.com/files/atom.xml
This will add a new subscription to watch for changes: This will add a new subscription to watch for changes:
``` ```
comitium add --watch 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, Note that when watching a page for changes, you should manually add a title,
otherwise the URL will be used. otherwise the URL will be used.