diff --git a/README.md b/README.md index 9c073ae..6d9d46d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,14 @@ # MarkIt -Cmdline bookmark management utility written using Python3 and SQLite3. Currently under development with implemented options working. - +Cmdline bookmark management utility written using Python3 and SQLite3. Currently under development with implemented options working. + +The SQLite3 database file is stored in `$HOME/.cache/bookmarks.db` for each user. + +It's advisable to copy URLs directly from the browser address bar, i.e., along with the leading `http://` or `https://` token. `markit` looks up title data (found within tags of HTML) from the web only for fully-formed HTTP or HTTPS URLs. + +You can either add or update or delete record(s) in one instance. A combination of these operations are not supported in a single instance. + +Search works in mysterious ways. All the keywords are treated as a single tag together. Partial sequential tag matches are shown in results. The same keywords are separately searched as unique tokens so that entries with matching URL or title data are also shown in results. + `markit` is GPLv3 licensed. If you find `markit` useful, please consider donating via PayPal.