diff --git a/README.md b/README.md new file mode 100644 index 0000000..780ebea --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# sxbm +Simple Unix Bookmark Manager, a posix compliant shell script for managing your bookmarks. + +The script stores your bookmarks on a plain text file making it easily portable. + +## Installation and Usage +Cone the repo. + +``` +git clone https://github.com/N-R-K/sxbm.git +``` + +Then just copy/move the script into your $PATH. +Instead of copying, you can also create a symlink. This way you can do a git pull to get updates. + +Run `sxbm --help` to see usage.