storj/cmd/netstate/README.md
2018-05-07 11:03:59 -06:00

25 lines
658 B
Markdown

# Network State Skateboard
### BoltDB Crud Interface
Small program provides a CRUD (create, read, update, delete) interface for paths of small values.
Can store value (i.e. "hello world") at `/my/test/file` and interact with `/my/test/file` through an api, backed by BoltDB.
To run:
```
go run cmd/net-state/main.go
```
You can also run using these flags: `-port=<port-number> -prod=<bool> -db=<db-name>`
Then you can use http methods (Put, Get, List, and Delete) to interact with small values stored on BoltDB.
To store a value to a PUT request body, use the format:
```
{
"value": "here's my value"
}
```
TODO:
- add functions for grpc + protobufs