summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authornytpu <alex@nytpu.com>2021-03-19 08:29:44 -0600
committernytpu <alex@nytpu.com>2021-03-19 08:29:44 -0600
commit2974c5413c388ed904cb95bc1ba6bc7aea0b5e21 (patch)
tree2252b6f339480be0ecdfee48f2125122d346bb98 /doc
parentdb626e0c662896ad6483d8834b0546e2f09e1a49 (diff)
remove list command and instead write "subscriptions.gmi" & "feed.gmi"
Diffstat (limited to 'doc')
-rw-r--r--doc/comitium.1.scd9
-rw-r--r--doc/quickstart.md3
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/comitium.1.scd b/doc/comitium.1.scd
index 4481e2c..20ed8d4 100644
--- a/doc/comitium.1.scd
+++ b/doc/comitium.1.scd
@@ -23,9 +23,6 @@ variety of feed formats:
*refresh* [_FLAGS_]
Check for new updates to subscriptions and update aggregator page.
-*list*
- List all subscriptions in a gemtext format suitable for remote bookmarking.
-
*add* [_FLAGS_] <_LINK_> [_TITLE_]
Add a new subscription. _LINK_ is a link to the feed or watched URL.
_TITLE_ is an optional title for the feed, otherwise a title will be
@@ -98,10 +95,14 @@ Within the data directory, the following files are used:
subscription (change its title, update a link, etc) it should be trivial to
manually edit.
-*subscriptions.gmi*
+*feed.gmi*
The outputted text/gemini file containing the subscription items. Is what
should be linked or copied to your server directory to publish it.
+*subscriptions.gmi*
+ A text/gemini list of all the feeds being aggregated, suitable for remote
+ bookmarking, etc. Should also be linked or copied to your server directory.
+
# EXAMPLES
This will add a new feed subscripton:
diff --git a/doc/quickstart.md b/doc/quickstart.md
new file mode 100644
index 0000000..0700104
--- /dev/null
+++ b/doc/quickstart.md
@@ -0,0 +1,3 @@
+# comitium quickstart
+
+