diff --git a/README.md b/README.md index a33af13..27dac70 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,59 @@ # MarkIt -Cmdline bookmark management utility written using Python3 and Sqlite3. Currently under development. +Cmdline bookmark management utility written using Python3 and SQLite3. Currently under development with implemented options working. + +`markit` is GPLv3 licensed. + +If you find `markit` useful, please consider donating via PayPal. +Donate Button with Credit Cards + +# Features +- Add, update or remove a bookmark +- Add tags to bookmarks +- Optionally fetch page title data from the web (default: disabled, use `-o`) +- Use (partial) tags or keywords to search bookmarks +- Open search results in browser +- Browser (Chromium and Firefox based) errors and warnings suppression +- Show all bookmarks in a go +- Delete all bookmarks +- Add a bookmark at Nth index, to fill deleted bookmark indexes +- Secure SQLite3 queries to access database +- Handle first level of redirections (reports IP blocking) +- Unicode in URL works +- UTF-8 request and response +- Works with Python 3.x +- Coloured output for clarity +- Manpage for quick reference +- Optional debug information +- Fast and clean (no ads or clutter) +- Minimal dependencies +- Open source and free + +# Installation + +`markit` requires Python 3.x to work. + +1. If you have git installed (the steps are tested on Ubuntu 14.04.3 x64_64): +
$ git clone https://github.com/jarun/markit/  
+$ cd markit
+$ sudo make install
+To remove, run: +
$ sudo make uninstall
+ +2. If you do not have git installed: +Download the development version source code. Extract, cd into the directory and run: +
$ sudo make install
+If you do not want to install, `markit` is standalone: +
$ chmod +x markit
+$ ./markit ...
+ +Goals +- +- Parse full page data??? Not sure, might end up writing a search engine like Google. ;) +- Optional password protection #License GPL v3 Copyright (C) 2015 by Arun Prakash Jana <engineerarun@gmail.com> - -Goals -- -- Parse the page being added and use keywords from Header, Title etc. -- Use tags to search pages -- Directly open in browser -- Parse full page data??? Not sure, might end up writing a search engine like Google. ;) -- Online and offline addition -- Optional password protection -- Update entries # Developer(s) Arun PraKash Jana <engineerarun@gmail.com>