Update README.md

2021-03-20 20:42:35 +01:00 · 2021-03-20 20:42:35 +01:00 · 9925920e04
parent f58c82a3ee
commit 9925920e04
1 changed files with 19 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,5 +1,24 @@
+# hs9001
+## Setup
+```
+go build
+#move hs9001 to a PATH location
+# Initialize database
+hs9001 init
+````
+
 Add this to .bashrc

+```
 if [ -n "$PS1" ] ; then
    PROMPT_COMMAND='hs9001 add "$(history 1)"'
 fi
+```
+
+## Usage
+### Search
+```
+hs9001 search "term"
+```
+
+Is is recommended to create an aias for search to make life easier.