improve readme

This commit is contained in:
boyska 2021-03-21 12:32:32 +01:00
parent 053af2e73a
commit 66c6b80019

View file

@ -3,14 +3,17 @@ When you have many bookmarks, you'd better have a good book full of marks.
![A cat reads Karl Marx](cat.jpeg)
What
=======
What: an informal specification
===================================
- keeps track of bookmarks
- has the concept of folder well integrated
Goals:
- keep track of bookmarks
- have the concept of folder well integrated
- make sharing with friends easy with already available technologies
- supports tags and descriptions, too
- one file per bookmark
- CLI-first
* but having a GUI would be nice, too
- python3
@ -44,11 +47,13 @@ First line is the URL.
now we need to store description and tags.
We want to be grep-friendly, so let's use a format borrowed from email (or from debian/control, if you want!):
```
URI: https://riseup.net/
Description: They are nice folks
Tag: privacy
Tag: change the world
Tag: email
```
Just avoid newlines in fields and you can do good queries just using grep