boyska/marxbook
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

improve readme

Browse source
This commit is contained in:
boyska 2021-03-21 12:32:32 +01:00
parent 053af2e73a
commit 66c6b80019
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
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) ![A cat reads Karl Marx](cat.jpeg)
What What: an informal specification
======= ===================================
- keeps track of bookmarks Goals:
- has the concept of folder well integrated - 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 - supports tags and descriptions, too
- one file per bookmark - one file per bookmark
- CLI-first - CLI-first
* but having a GUI would be nice, too
- python3 - python3
@ -44,11 +47,13 @@ First line is the URL.
now we need to store description and tags. 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!): 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/ URI: https://riseup.net/
Description: They are nice folks Description: They are nice folks
Tag: privacy Tag: privacy
Tag: change the world Tag: change the world
Tag: email Tag: email
```
Just avoid newlines in fields and you can do good queries just using grep Just avoid newlines in fields and you can do good queries just using grep