diff --git a/README.md b/README.md index 3771356..e83b287 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # hodlhodl-bot +Simple golang command to call HODLHODL [API](https://hodlhodl.com/api/docs) endpoints. + +The command usage is as following: + +./hodlhodl-bot [-t] watchs-notifs + +-t: sleep time in seconds between each call to api when running in daemon watch mode (default: 60) + +watch: the watch command keeps running and polling the notifications endpoint, if new notifications are detected print them stdou. In this mode the program can only be stopped with CTRL+C + + + +