commit 71ac49b36f1e9402109b0c334bbdea380bda803b
parent f94da1704831a8d34790eba8f88d6b8d9c3cb288
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sun, 27 Oct 2024 16:15:21 +0100
feat: add a readme with screenshots
Diffstat:
| A | README.md | | | 83 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 83 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,83 @@
+# Rememori
+
+Please send patches or remarks to
+[jayvii+rememori[AT]posteo[DOT]de](mailto:jayvii+rememori[AT]poste[DOT]de)
+
+A simple file-based, database-free bookmarking and notes application that is
+light on resources.
+
+## Features
+
+Rememori is currently is heavy development and the feature set may change at any
+time! Here are the currently implemented most important ones.
+
+Rememori has multi-lingual support, all screenshots you see below are in German,
+however, Rememori switches transparently between languages, depending on your
+web browser's configuration. CUrrently supported are:
+
+- English
+- German
+
+Rememori uses the superb [Simple.CSS](https://simplecss.org/) class-less styling
+framework, which supports automatic dark and bright mode. The screenshots below
+show **both** modes at the same time.
+
+### Categories
+
+Bookmarks / Notes are stored file-based in simple `.txt` files, which are sorted
+within categories that are created automatically and swiftly on-demand, whenever
+you create a new note.
+
+The main view shows you all categories and how many notes each one contain. The
+category buttons are sorted by number of notes in each. From here you can
+directly jump into your notes!
+
+
+
+### Notes List
+
+Clicking on any of the Categories, lists all notes within this category in a
+simple list. If the note contains a URL in the first line of its content, the
+item-title in the list will turn into a link to that URL.
+
+You can also view / change and delete the note from that list. The list is
+sorted based by time / date of the last change to a note.
+
+
+
+### Creating and Editing Notes
+
+Notes are written in simple, unstructed text (hence the `.txt` file it is stored
+in). The "View" / "Edit" as well as the "New Note" mode gives you the ability to
+change a note's content, its category and its name.
+
+Leaving the category portion empty, will assign the note into the `unknown`
+category. If you leave the file name field empty, Rememori will try to figure
+out an appropriate file name itself.
+
+If the first line of the note contains a URL, Rememori will try to fetch the
+webpage's name and use it as the name of your note (you can see the result of
+this on the screenshot below):
+
+
+
+### Search
+
+Remmori also has a simple search integrated. It will simply match the keywords
+you type into the search field with all notes' content and title. It then
+provides you with a list of all notes that had matches, sorted by the number of
+matches.
+
+
+
+## Setup
+
+Coming soon...
+
+## License
+
+Rememori is licensed under AGPL-3.0-or-later.
+
+Other bundled assets are:
+
+- [simple.css](https://simplecss.org/): MIT License (c) Kev Quirk
