~edwargix/axon

b0dcf7553acc4a161e59017184ee2d75cd601a1e — David Florness 3 years ago 0c77367
README: add description of what the program does on invocation
1 files changed, 10 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +10 -1
@@ 11,7 11,7 @@ neurons that seem to connect to

# usage

via go get:
Install via go get:
```
go get git.hnitbjorg.xyz/~edwargix/axon
$(go env GOPATH)/bin/axon help


@@ 24,6 24,15 @@ go build
./axon help
```

When you first run one of the subcommands, you'll be prompted for the username
and password of a Matrix account.  You'll only be asked for these credentials on
your first invocation of axon since the access token will get stored in
`~/.local/shared/axon/auth.json` (with ACL bits 600).  The subcommand will then
do some little bit of functionality on the Matrix network from the perspective
of your account using the [Client-Server
API](https://matrix.org/docs/spec/client_server/r0.6.1).  Run `axon help
<subcommand>` so see what a given subcommand does.

# contributing

Please send requests/patches to