Update documentation
This commit is contained in:
Arun Prakash Jana
parent
be50451d1d
commit
3493b4269d
34
README.md
34
README.md
@ -27,18 +27,16 @@
|
||||
|
||||
`buku` is a powerful bookmark manager written in Python3 and SQLite3. When I started writing it, I couldn't find a flexible cmdline solution with a private, portable, merge-able database along with seamless GUI integration. Hence, `Buku` (after my son's nickname, meaning *close to the heart* in my language).
|
||||
|
||||
`buku` fetches the title of a bookmarked url and stores it along with any user-provided comments and tags. You can use your favourite editor to compose and update bookmarks. With multiple search options, including regex and a deep scan mode (particularly for URLs), it can find any bookmark instantly. Multiple search results can be opened in the browser at once. `buku` can look up the latest snapshot of a broken link on the Wayback Machine. There's an Easter egg to revisit random forgotten bookmarks too!
|
||||
|
||||
For GUI and browser integration (or to sync bookmarks with your favourite bookmark management service), refer to the wiki page on [System integration](https://github.com/jarun/Buku/wiki/System-integration). If you prefer the terminal, the [shell completion](#shell-completion) scripts can be handy.
|
||||
`buku` fetches the title of a bookmarked url and stores it along with any user-provided comments and tags. You can use your favourite editor to compose and update bookmarks. With multiple search options, including regex and a deep scan mode (particularly for URLs), it can find any bookmark instantly. Multiple search results can be opened in the browser at once. `buku` can look up the latest snapshot of a broken link on the Wayback Machine. There's an Easter egg to revisit random forgotten bookmarks too! *Buku* is too busy to track you - no hidden history, obsolete records, usage analytics or homing. For more details, please refer to the wiki page on [operational notes](https://github.com/jarun/Buku/wiki/Operational-notes).
|
||||
|
||||
[bukuserver](https://github.com/jarun/Buku/tree/master/bukuserver) exposes a browsable frontend on a local webhost server.
|
||||
|
||||
We have one of the best documentation around. You can start with the [Examples](#examples). *Buku* is too busy to track you - no hidden history, obsolete records, usage analytics or homing. For more details, please refer to the wiki page on [operational notes](https://github.com/jarun/Buku/wiki/Operational-notes).
|
||||
If you prefer the cli on a desktop, for GUI and browser integration (or to sync bookmarks with your favourite bookmark management service) refer to the wiki page on [System integration](https://github.com/jarun/Buku/wiki/System-integration). The [shell completion](#shell-completion) scripts are handy.
|
||||
|
||||
We have one of the best documentation around. You can start with the [Examples](#examples).
|
||||
|
||||
There are several [projects based on `buku`](#related-projects), including a browser plug-in.
|
||||
|
||||
Missing a feature? There's a rolling [ToDo List](https://github.com/jarun/Buku/issues/268) with identified tasks. Contributions are welcome! Please follow the [PR guidelines](https://github.com/jarun/Buku/wiki/PR-guidelines).
|
||||
|
||||
*Love smart and efficient terminal utilities? Explore my repositories. Buy me a cup of coffee if they help you.*
|
||||
|
||||
<p align="center">
|
||||
@ -63,24 +61,24 @@ Missing a feature? There's a rolling [ToDo List](https://github.com/jarun/Buku/i
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Editor integration](#editor-integration)
|
||||
- [Collaborators](#collaborators)
|
||||
- [Contributions](#contributions)
|
||||
- [Related projects](#related-projects)
|
||||
- [In the Press](#in-the-press)
|
||||
|
||||
### Features
|
||||
|
||||
- Lightweight, clean interface, custom colors
|
||||
- Text editor integration
|
||||
- Fetch, edit page title; add tags and notes
|
||||
- Powerful search modes (regex, substring...)
|
||||
- Continuous search with on the fly mode switch
|
||||
- Open bookmarks and search results in browser
|
||||
- Manual encryption support
|
||||
- Store bookmarks with title (auto-fetched), tags and notes
|
||||
- Auto-import from Firefox, Google Chrome and Chromium
|
||||
- Import/export bookmarks from/to HTML, Markdown or Orgfile
|
||||
- Open bookmarks and search results in browser
|
||||
- Shorten, expand URLs, browse cached page from Wayback Machine
|
||||
- Smart tag management using redirection (>>, >, <<)
|
||||
- Text editor integration
|
||||
- Lightweight, clean interface, custom colors
|
||||
- Powerful search options (regex, substring...)
|
||||
- Continuous search with on the fly mode switch
|
||||
- Portable, merge-able database to sync between systems
|
||||
- Multithreaded full DB refresh
|
||||
- Import/export bookmarks from/to HTML, Markdown or Orgfile
|
||||
- Smart tag management using redirection (>>, >, <<)
|
||||
- Multithreaded full DB refresh, manual encryption support
|
||||
- Shell completion scripts, man page with handy examples
|
||||
|
||||
### Installation
|
||||
@ -461,6 +459,10 @@ Copyright © 2015-2018 [Arun Prakash Jana](mailto:engineerarun@gmail.com)
|
||||
<br>
|
||||
<p><a href="https://gitter.im/jarun/Buku"><img src="https://img.shields.io/gitter/room/jarun/buku.svg?maxAge=2592000" alt="gitter chat" /></a></p>
|
||||
|
||||
### Contributions
|
||||
|
||||
Missing a feature? There's a rolling [ToDo List](https://github.com/jarun/Buku/issues/268) with identified tasks. Contributions are welcome! Please follow the [PR guidelines](https://github.com/jarun/Buku/wiki/PR-guidelines).
|
||||
|
||||
### Related projects
|
||||
|
||||
- [bukubrow](https://github.com/SamHH/bukubrow), WebExtension for browser integration
|
||||
|
||||
19
buku.1
19
buku.1
@ -9,19 +9,18 @@ is a command-line utility to store, tag, search and organize bookmarks.
|
||||
.PP
|
||||
.B Features
|
||||
.PP
|
||||
* Lightweight, clean interface, custom colors
|
||||
* Text editor integration
|
||||
* Fetch, edit page title; add tags and notes
|
||||
* Powerful search modes (regex, substring...)
|
||||
* Continuous search with on the fly mode switch
|
||||
* Open bookmarks and search results in browser
|
||||
* Manual encryption support
|
||||
* Store bookmarks with title (auto-fetched), tags and notes
|
||||
* Auto-import from Firefox, Google Chrome and Chromium
|
||||
* Import/export bookmarks from/to HTML, Markdown or Orgfile
|
||||
* Open bookmarks and search results in browser
|
||||
* Shorten, expand URLs, browse cached page from Wayback Machine
|
||||
* Smart tag management using redirection (>>, >, <<)
|
||||
* Text editor integration
|
||||
* Lightweight, clean interface, custom colors
|
||||
* Powerful search options (regex, substring...)
|
||||
* Continuous search with on the fly mode switch
|
||||
* Portable, merge-able database to sync between systems
|
||||
* Multithreaded full DB refresh
|
||||
* Import/export bookmarks from/to HTML, Markdown or Orgfile
|
||||
* Smart tag management using redirection (>>, >, <<)
|
||||
* Multithreaded full DB refresh, manual encryption support
|
||||
* Shell completion scripts, man page with handy examples
|
||||
.SH OPERATIONAL NOTES
|
||||
.PP
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user