README: add installation and quickstart
[jan-pona-mute.git] / README.md
1 Jan Pona Mute
2 =============
3
4 The name is Toki Pona and means "many friends".
5
6 This is a very simple command line client for Diaspora that helps me
7 deal 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
13 It's *very* limited but it's helping me get started using the
14 [https://github.com/marekjm/diaspy diaspy] Python library.
15
16 Installation
17 ------------
18
19 We need the [https://github.com/marekjm/diaspy diaspy] library. Use
20 `pip` to install it.
21
22 ```
23 $ pip3 install diaspy
24 ```
25
26 Quickstart
27 ==========
28
29 ```
30 $ python3 jan-pona-mute.py
31 Welcome to Diaspora! Use the intro command for a quick introduction.
32 Pager set: /usr/bin/fold
33 > account kensanata@pluspora.com
34 Username and pod set: kensanata@pluspora.com
35 > password *secret*
36 Password set
37 > login
38 1. 2019-08-13T19:40:17.000Z Joe Doe has liked your post I've started writing...
39 2. 2019-08-13T17:59:23.000Z Joe Doe commented on your post Please help me wi...
40 3. 2019-08-13T17:03:45.000Z Jane Doe has liked your post I've started writin...
41 4. 2019-08-13T15:02:50.000Z June Doe commented on your post I don't like Mon...
42 5. 2019-08-13T14:48:51.000Z John Doe liked your post Monday again! What am I...
43 Enter a number to select the notification.
44 > 1
45 2019-08-13T19:40:17.000Z Joe Doe has liked your post I've started writing...
46 Loading...
47
48 I've started writing a Diaspora client for the command line. It's called Jan Pona
49 Mute which means as much as "many friends" in English. It's written in Python and
50 doesn't do much.
51 > comments
52 There are no comments on the selected post.
53 > comment This is me leaving a comment.
54 Comment posted
55 > comments
56
57 1. 2019-08-13T20:04:35.000Z Alex Schroeder
58
59 Alex Schroeder (e3bd7110b2ee013620f200505608f9fe): This is me leaving a comment.
60 > quit
61 Be safe!
62 ```
63
64 Next Step
65 ---------
66
67 Use the `save` command to save the login information (including the
68 password!) to an init file.
69
70 The init files searched are:
71
72 1. `~/.config/jan-pona-mute/login`
73 2. `~/.config/.jan-pona-mute`
74 3. `~/.jan-pona-mute`
75
76 If one of them exists while starting up, that's the file that gets
77 written. If none exists, the first one is going to be created by the
78 `save` command.
79
80 Any further commands you put into the file are simple executed as if
81 you were to type them every time you start the program.
82
83 Reference
84 ---------
85
86 So much is still in flux. Please use the `help` command to learn more.