mirror of https://github.com/Calamitous/iris.git
The Documentation Donkey kicked me
This commit is contained in:
parent
9fd530c41c
commit
28db4d3e20
53
README.md
53
README.md
|
|
@ -40,7 +40,7 @@ Welcome to Iris v. 1.0.11. Type "help" for a list of commands.; Ctrl-D or 'quit
|
|||
|
||||
| ID | U | TIMESTAMP | AUTHOR | TITLE
|
||||
| 1 | | 2018-01-24T05:49:53Z | jimmy_foo@ctrl-c.club | Welcome!
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for imp...
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for a...
|
||||
|
||||
jimmy_foo@ctrl-c.club>
|
||||
```
|
||||
|
|
@ -50,11 +50,13 @@ jimmy_foo@ctrl-c.club>
|
|||
* [[t]opics](#topics)
|
||||
* [[u]nread](#unread)
|
||||
* [Display topic](#display-topic)
|
||||
* [[n]ext](#next)
|
||||
* [[c]ompose](#compose)
|
||||
* [[r]eply](#reply)
|
||||
* [[e]dit](#edit)
|
||||
* [[d]elete and un[d]elete](#delete)
|
||||
* [[m]ark_read](#mark_read)
|
||||
* [mark_all_read](#mark_all_read)
|
||||
* [[f]reshen](#freshen)
|
||||
* [reset OR clear](#reset-or-clear)
|
||||
* [[i]nfo](#info)
|
||||
|
|
@ -72,7 +74,7 @@ jimmy_foo@ctrl-c.club> topics
|
|||
|
||||
| ID | U | TIMESTAMP | AUTHOR | TITLE
|
||||
| 1 | | 2018-01-24T05:49:53Z | jimmy_foo@ctrl-c.club | Welcome!
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for i...
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for a...
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -93,7 +95,7 @@ This outputs a list of top-level topics that have not been read, or have unread
|
|||
jimmy_foo@ctrl-c.club> unread
|
||||
|
||||
| ID | U | TIMESTAMP | AUTHOR | TITLE
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for i...
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for a...
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -110,7 +112,7 @@ jimmy_foo@ctrl-c.club> topics
|
|||
|
||||
| ID | U | TIMESTAMP | AUTHOR | TITLE
|
||||
| 1 | | 2018-01-24T05:49:53Z | jimmy_foo@ctrl-c.club | Welcome!
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for i...
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for a...
|
||||
|
||||
jimmy_foo@ctrl-c.club> 1
|
||||
*** [1] On 2018-01-24T05:49:53Z, jimmy_foo@ctrl-c.club posted...-----------------
|
||||
|
|
@ -126,6 +128,32 @@ It's good to see everyone here!
|
|||
|
||||
---
|
||||
|
||||
### [n]ext
|
||||
`next, n - Read the next unread topic`
|
||||
|
||||
This command displays the first topic which is unread or has unread replies.
|
||||
```
|
||||
jimmy_foo@ctrl-c.club> topics
|
||||
|
||||
| ID | U | TIMESTAMP | AUTHOR | TITLE
|
||||
| 1 | | 2018-01-24T05:49:53Z | jimmy_foo@ctrl-c.club | Welcome!
|
||||
| 2 | 1 | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for a...
|
||||
|
||||
jimmy_foo@ctrl-c.club> next
|
||||
*** [2] On 2018-01-24T16:13:05Z, jerry_berry@ctrl-c.club posted...---------------
|
||||
Suggestions for a tilde home?
|
||||
|
||||
I'm trying to decide on a new place in the tildeverse to call home. Any ideas?
|
||||
---------------------------------------------------------------------------------
|
||||
|
||||
| === [M4] On 2018-01-30T22:50:38Z, jimmy_foo@ctrl-c.club replied...-----------
|
||||
| Have you considered https://ctrl-c.club?
|
||||
| -----------------------------------------------------------------------------
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### [c]ompose
|
||||
`compose, c - Add a new topic`
|
||||
|
||||
|
|
@ -149,7 +177,7 @@ jimmy_foo@ctrl-c.club~> topics
|
|||
|
||||
| ID | U | TIMESTAMP | AUTHOR | TITLE
|
||||
| 1 | | 2018-01-24T05:49:53Z | jimmy_foo@ctrl-c.club | Welcome!
|
||||
| 2 | | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for i...
|
||||
| 2 | | 2018-01-24T16:13:05Z | jerry_berry@ctrl-c.club | Suggestions for a...
|
||||
| 3 | 1 | 2018-01-23T00:13:44Z | jimmy_foo@ctrl-c.club | How do I spoo the...
|
||||
```
|
||||
|
||||
|
|
@ -313,6 +341,13 @@ Mark a topic and all its replies as read without displaying them.
|
|||
|
||||
---
|
||||
|
||||
### [m]ark_all_read
|
||||
`mark_all_read - Mark all messages as read`
|
||||
|
||||
Marks all topics and their replies as read without displaying them.
|
||||
|
||||
---
|
||||
|
||||
### [f]reshen
|
||||
`freshen, f - Reload to get any new messages`
|
||||
|
||||
|
|
@ -355,6 +390,7 @@ There are a few options you can pass in from the command-line:
|
|||
* [--version, -v](#--version-v)
|
||||
* [--stats, -s](#--stats-s)
|
||||
* [--interactive, -i](#--interactive-i)
|
||||
* [--mark-all-read](#--mark-all-read)
|
||||
* [--dump, -d](#--dump-d)
|
||||
* [--help, -h](#--help-h)
|
||||
* [--debug](#--debug)
|
||||
|
|
@ -400,6 +436,13 @@ This is the mode that Iris enters if no options are passed on the command-line.
|
|||
|
||||
---
|
||||
|
||||
|
||||
### --mark-all-read
|
||||
|
||||
This command simply marks every message as read in Iris. It's a quick way to get to "Irisbox Zero".
|
||||
|
||||
---
|
||||
|
||||
### --dump/-d
|
||||
|
||||
This reads the entire message corpus and outputs it as a stream of JSON data, suitable for piping into a backup file, `jq` parser, or similar.
|
||||
|
|
|
|||
4
iris.rb
4
iris.rb
|
|
@ -1011,6 +1011,7 @@ class Interface
|
|||
'# (topic id) - Read specified topic',
|
||||
'next, n - Read the next unread topic',
|
||||
'mark_read #, m # - Mark the associated topic as read',
|
||||
'mark_all_read - Mark all messages as read',
|
||||
'help, h, ? - Display this text',
|
||||
'',
|
||||
'WRITING',
|
||||
|
|
@ -1023,7 +1024,6 @@ class Interface
|
|||
'freshen, f - Reload to get any new messages',
|
||||
'reset, clear - Fix screen in case of text corruption',
|
||||
'info, i - Display Iris version and message stats',
|
||||
'mark_all_read - Mark all messages as read',
|
||||
'quit, q - Quit Iris',
|
||||
'',
|
||||
'Full documentation available here:',
|
||||
|
|
@ -1070,8 +1070,8 @@ class CLI
|
|||
'--help, -h - Display this text.',
|
||||
'--version, -v - Display the current version of Iris.',
|
||||
'--stats, -s - Display Iris version and message stats.',
|
||||
'--mark-all-read - Mark all messages as read.',
|
||||
'--interactive, -i - Enter interactive mode (default)',
|
||||
'--mark-all-read - Mark all messages as read.',
|
||||
'--dump, -d - Dump entire message corpus out.',
|
||||
'--test-file <filename>, -f <filename> - Use the specified test file for messages.',
|
||||
'--debug - Print warnings and debug informtation during use.',
|
||||
|
|
|
|||
Loading…
Reference in New Issue