README: update rc filenames
[jan-pona-mute.git] / README.md
CommitLineData
d6e4e60d
AS
1Jan Pona Mute
2=============
3
4The name is Toki Pona and means "many friends".
5
6This is a very simple command line client for Diaspora that helps me
7deal with my specific use-cases:
8
9- I want to check Diaspora for new comment on my threads
10- I want to leave new comments on my threads
11- I want to delete comments I left by mistake
12
13It's *very* limited but it's helping me get started using the
14[https://github.com/marekjm/diaspy diaspy] Python library.
bfc18b3e
AS
15
16Installation
17------------
18
b8a9d951 19We need the [https://github.com/marekjm/diaspy diaspy] library.
bfc18b3e 20
a5282113 21```text
b8a9d951
AS
22$ git clone https://github.com/marekjm/diaspy.git
23$ cd diaspy
24$ pip3 install .
bfc18b3e
AS
25```
26
b8a9d951
AS
27This gives me version 0.6.0. when I use `pip3 install diaspy` I get
28version 0.3.0 which doesn't work.
29
bfc18b3e
AS
30Quickstart
31==========
32
a5282113 33```text
bfc18b3e
AS
34$ python3 jan-pona-mute.py
35Welcome to Diaspora! Use the intro command for a quick introduction.
36Pager set: /usr/bin/fold
37> account kensanata@pluspora.com
38Username and pod set: kensanata@pluspora.com
39> password *secret*
40Password set
41> login
42 1. 2019-08-13T19:40:17.000Z Joe Doe has liked your post I've started writing...
43 2. 2019-08-13T17:59:23.000Z Joe Doe commented on your post Please help me wi...
44 3. 2019-08-13T17:03:45.000Z Jane Doe has liked your post I've started writin...
45 4. 2019-08-13T15:02:50.000Z June Doe commented on your post I don't like Mon...
46 5. 2019-08-13T14:48:51.000Z John Doe liked your post Monday again! What am I...
47Enter a number to select the notification.
48> 1
492019-08-13T19:40:17.000Z Joe Doe has liked your post I've started writing...
50Loading...
51
52I've started writing a Diaspora client for the command line. It's called Jan Pona
53Mute which means as much as "many friends" in English. It's written in Python and
54doesn't do much.
55> comments
56There are no comments on the selected post.
57> comment This is me leaving a comment.
58Comment posted
59> comments
60
61 1. 2019-08-13T20:04:35.000Z Alex Schroeder
62
63Alex Schroeder (e3bd7110b2ee013620f200505608f9fe): This is me leaving a comment.
64> quit
65Be safe!
66```
67
68Next Step
69---------
70
71Use the `save` command to save the login information (including the
72password!) to an init file.
73
74The init files searched are:
75
761. `~/.config/jan-pona-mute/login`
281401ba 772. `~/.jan-pona-mute.d/login`
bfc18b3e
AS
783. `~/.jan-pona-mute`
79
80If one of them exists while starting up, that's the file that gets
81written. If none exists, the first one is going to be created by the
82`save` command.
83
84Any further commands you put into the file are simple executed as if
85you were to type them every time you start the program.
86
8aac6bbd
AS
87Notes
88-----
89
90One thing I care about is editing comments with my favourite editor
91and previewing them. This works really well if you have `mdcat` as it
92renders Markdown. Here's the workflow:
93
941. check notifications
952. pick a post
963. show latest comments
974. compose a note
985. preview note
996. leave a comment with that note
100
101This is what it looks like, assuming your editor is `ed`:
102
a5282113 103```text
8aac6bbd
AS
104> notifications
105...
106> 1
107...
108> comments
109...
110> note nice
111/home/alex/.config/jan-pona-mute/notes/nice: No such file or directory
112a
113OK, I like this. Thanks!
114.
115w
11625
117q
118 1. nice
119Use 'edit' to create a note.
120> preview 1
121OK, I like this. Thanks!
122> comment 1
123```
124
bfc18b3e
AS
125Reference
126---------
127
128So much is still in flux. Please use the `help` command to learn more.