- I want to delete comments I left by mistake
It's *very* limited but it's helping me get started using the
-[https://github.com/marekjm/diaspy diaspy] Python library.
+[diaspy](https://github.com/marekjm/diaspy) Python library.
+
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
+**Table of Contents**
+
+- [Installation](#installation)
+- [Quickstart](#quickstart)
+- [Next Step](#next-step)
+- [Notes](#notes)
+- [Reference](#reference)
+
+<!-- markdown-toc end -->
Installation
------------
-We need the [https://github.com/marekjm/diaspy diaspy] library.
+We need the [diaspy](https://github.com/marekjm/diaspy) library.
```text
$ git clone https://github.com/marekjm/diaspy.git
$ pip3 install .
```
-This gives me version 0.6.0. when I use `pip3 install diaspy` I get
-version 0.3.0 which doesn't work.
+This gives me version 0.6.0. When I use `pip3 install diaspy` I get
+version 0.3.0 and that doesn't work. 🤷
+
+You need to download this program as well, obviously.
+
+```text
+$ git clone https://alexschroeder.ch/cgit/jan-pona-mute
+```
+
+With that done, you should be able to run it:
+
+```text
+$ python3 jan-pona-mute/jan-pona-mute.py
+```
Quickstart
-==========
+----------
```text
$ python3 jan-pona-mute.py
> password *secret*
Password set
> login
+Setting up a connection...
+Logging in...
+> notifications
1. 2019-08-13T19:40:17.000Z Joe Doe has liked your post I've started writing...
2. 2019-08-13T17:59:23.000Z Joe Doe commented on your post Please help me wi...
3. 2019-08-13T17:03:45.000Z Jane Doe has liked your post I've started writin...
The init files searched are:
1. `~/.config/jan-pona-mute/login`
-2. `~/.config/.jan-pona-mute`
+2. `~/.jan-pona-mute.d/login`
3. `~/.jan-pona-mute`
If one of them exists while starting up, that's the file that gets
`save` command.
Any further commands you put into the file are simple executed as if
-you were to type them every time you start the program.
+you were to type them every time you start the program. A simple
+change would be to add `notifications` as a command to the end of the
+file.
Notes
-----
One thing I care about is editing comments with my favourite editor
-and previewing them. This works really well if you have `mdcat` as it
-renders Markdown. Here's the workflow:
+and previewing them. This works really well if you have
+[mdcat](https://github.com/lunaryorn/mdcat) as it renders Markdown.
+Here's the workflow:
1. check notifications
2. pick a post
---------
So much is still in flux. Please use the `help` command to learn more.
+
+* use **intro** if you want to skip reading the rest of this list 😅
+
+* use **account**, **password**, and **login** to login into your
+ account; use **save** to store these three commands in your init
+ file
+
+* use **shortcuts** to show the current shortcuts; use **shortcut** to
+ define a new shortcut; these are good commands to add to your init
+ file (the **save** command won't do this for you)
+
+* use **notifications** to see the latest notifications, use
+ **notifications reload** to update the list; this is also a good
+ command to add to your init file
+
+* use **home** to see your home stream, use **home reload** to update
+ the list; use **home all** to see the full list; use **home 3** to
+ see the last 3 items
+
+* use **show** and a number to show the post a notification is
+ referring to, or to choose a post from your home stream; this is
+ what then allows you to use **comments** to show the comments to
+ that post; use **comments 3** to see the last 3 items
+
+* use **comment** to post a comment, use **post** to write a new post;
+ if you use a number instead of a writing a text, the number refers
+ to a note (see below)
+
+* use **undo** to delete a comment or post after writing it; use
+ **delete comment** or **delete post** to delete them at a later date
+
+* use **edit** and a filename to write a note; use **notes** to list
+ your notes; use **preview** to show a note; use **delete note** to
+ delete a note
+
+* use **editor** to set your favourite editor (or set the EDITOR
+ environment variable); use **pager** to set your favourite page (or
+ set the PAGER environment variable); consider installing
+ [mdcat](https://github.com/lunaryorn/mdcat) and using it as your pager
+
+* use **info** to review your settings
+
+* use **quit** to end the program
projects / jan-pona-mute.git / blobdiff