README.md (6060B)
1 # Rememori
2
3 Please send patches or remarks to
4 [jayvii+rememori[AT]posteo[DOT]de](mailto:jayvii+rememori[AT]poste[DOT]de)
5
6 A simple file-based, database-free bookmarking and notes application that is
7 light on resources.
8
9 ## Features
10
11 Rememori is currently is heavy development and the feature set may change at any
12 time! Here are the currently implemented most important ones.
13
14 Rememori has multi-lingual support, all screenshots you see below are in German,
15 however, Rememori switches transparently between languages, depending on your
16 web browser's configuration. CUrrently supported are:
17
18 - English
19 - German
20
21 Rememori uses the superb [Simple.CSS](https://simplecss.org/) class-less styling
22 framework, which supports automatic dark and bright mode. The screenshots below
23 show **both** modes at the same time.
24
25 ### Categories
26
27 Bookmarks / Notes are stored file-based in simple `.txt` files, which are sorted
28 within categories that are created automatically and swiftly on-demand, whenever
29 you create a new note.
30
31 The main view shows you all categories and how many notes each one contain. The
32 category buttons are sorted by number of notes in each. From here you can
33 directly jump into your notes!
34
35 
36
37 ### Notes List
38
39 Clicking on any of the Categories, lists all notes within this category in a
40 simple list. If the note contains a URL in the first line of its content, the
41 item-title in the list will turn into a link to that URL.
42
43 You can also view / change and delete the note from that list. The list is
44 sorted based by time / date of the last change to a note.
45
46 
47
48 ### Creating and Editing Notes
49
50 Notes are written in simple, unstructed text (hence the `.txt` file it is stored
51 in). The "View" / "Edit" as well as the "New Note" mode gives you the ability to
52 change a note's content, its category and its name.
53
54 Leaving the category portion empty, will assign the note into the `unknown`
55 category. If you leave the file name field empty, Rememori will try to figure
56 out an appropriate file name itself.
57
58 If the first line of the note contains a URL, Rememori will try to fetch the
59 webpage's name and use it as the name of your note (you can see the result of
60 this on the screenshot below):
61
62 
63
64 ### Search
65
66 Rememori also has a simple search integrated. It will simply match the keywords
67 you type into the search field with all notes' content and title. It then
68 provides you with a list of all notes that had matches, sorted by the number of
69 matches.
70
71 
72
73 ### API Endpoints
74
75 Rememori provides simple API endpoints that can be used via `POST` and `GET`
76 requests.
77
78 The `/api/new.php` endpoint will create a new note given the `user`, `token` and
79 `content` arguments as well as the optional `category` argument.
80
81 The `/api/rss.php` endpoint will return an
82 [Atom RSS Feed](https://en.wikipedia.org/wiki/Atom_(Web_standard)) sorted by
83 time/date of all notes or for a specific category (for example a `ReadLater`
84 category). It requires the `user` and `token` arguments as well as the optional
85 `category` argument.
86
87 ## Using Shortcuts to save Notes to Rememori
88
89 ### Desktop (Webbrowser)
90
91 Rememori features a simple bookmarklet in the navigation menu. A user can
92 simply drag this into their web browser's bookmarks toolbar to send any webpage
93 they are currently to to Rememori with a single click on the bookmark item in
94 their browser's toolbar.
95
96 The bookmarklet contains a simple Javascript function (created in
97 [lib/bookmarklet.php](https://src.jayvii.de/pub/rememori/file/lib/bookmarklet.php.html))
98 that will prompt the user for a category and send the currently opened page of
99 your web browser to the `/api/new.php` [API endpoint](#api-endpoints).
100
101 ### Android
102
103 On Android, you may use Apps like
104 [HTTP Shortcuts](https://http-shortcuts.rmy.ch/) (also available on
105 [F-Droid](https://f-droid.org/en/packages/ch.rmy.android.http_shortcuts/)) to
106 share text and URLs through Android's share-intend.
107
108 To set up HTTP Shortcuts, open the app and
109 [create new variables](https://http-shortcuts.rmy.ch/variables):
110
111 1. `rememori_server`: "https://rememori.example.com" (your rememori URL)
112 2. `rememori_user`: "me" (your username)
113 3. `rememori_token`: "my-secret-token" (an extra password you need to create)
114 4. `text_and_url`. Ensure this variable has the options "Allow Share..." and
115 "only text" checked
116
117 Then create a new shortcut for each share-option with its own category. Name it
118 appropriately, for example `Rememori (category: ReadItLater)`.
119
120 Under "General settings", set the method `GET` and insert following URL (adjust
121 the category accordingly. In the example below it is `ReadItLater`):
122
123 ```
124 {rememori_server}/api/new.php?category=ReadItLater&user={rememori_user}&token={rememori_token}&content={text_and_url}
125 ```
126
127 Save the shortcut and you are good to go! When sharing text or URLs from any
128 app, you may now choose the newly created shortcut to send it directly to your
129 rememori instance.
130
131 ## FAQs
132
133 1. **How do I add the bookmarklet to my Web-Browser?**
134
135 Simply go to the "Account" section in Rememori and drag the button labeled
136 "Rememori" under the Bookmarklet section to your browser's bookmarks toolbar:
137
138 
139
140 [You can find a higher resolution video here](https://paste.jayvii.de/369db1fd82260da5f50b1c7865764b122fa7f5d1ac4f506d2c0dc11079556e03)
141
142 ## Setup
143
144 Coming soon...
145
146 ## License
147
148 Rememori is licensed under AGPL-3.0-or-later.
149
150 Other bundled assets are:
151
152 - [simple.css](https://simplecss.org/): MIT License (c) Kev Quirk
