From c62a533f046339fbb18ffe7e5e58fc106f1881b7 Mon Sep 17 00:00:00 2001 From: Zack Date: Sun, 7 Feb 2016 22:01:26 -0500 Subject: [PATCH] Update README.md Former-commit-id: 142d9e52505ebb82eb2dca6e2358b07671e09e9a [formerly aef9d274ebefcc239c450823bc10b66939c1249d] [formerly 15dd943218c7f0ceb3fbaac19221aa27aa5ec01b [formerly 4d1de7a891344a9cdd6cd3c81b6710a8ac51190c]] Former-commit-id: e6f37ce2830807b5c494d8e287e9ef0c0a61eaf2 [formerly 63ba5cd0031e32133c4e81cf2b1cdd2102597c1b] Former-commit-id: bbd2a40f3abd12fcd44a92beaee5e7b36b47d516 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 822b8ba..4f5cd04 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,27 @@ Be cautious about writing sensitive information in the notes as anyone with the # Install `go get github.com/schollz/cowyo` + +# Usage + +``` +$ ./cowyo --help +cowyo: a websocket notepad +run this to start the server and then visit localhost at the port you specify +(see parameters). +Example: 'cowyo localhost' +Example: 'cowyo -p :8080 localhost' +Example: 'cowyo -db /var/lib/cowyo/db.bolt localhost' +Example: 'cowyo -p :8080 -crt ssl/server.crt -key ssl/server.key localhost' +Options: + -crt string + location of ssl crt + -db string + location of database file (default "/home/mu/cowyo/data.db") + -httptest.serve string + if non-empty, httptest.NewServer serves on this address and blocks + -key string + location of ssl key + -p string + port to bind (default ":12312")``` +```