feat: Improved readme

Added plan features to README.
Added requirements for developer for help.
Added description of project and main goal.
Fixed usage in console tool.

version: 0.1.2

Author: sah4ez

Makefile

@@ -1,12 +1,12 @@
-VERSION=0.1.1
+VERSION=0.1.2
 NAME=pspk
 GIT_REV?=$(shell git rev-parse --short HEAD)
 LDFLAGS=-ldflags "-X main.Version=$(VERSION) -X main.Hash=$(GIT_REV) -X main.BuildDate=$(BUILD_DATE)"
 GO=GO111MOUDLE=on go
 
 
 build:
-	VERSION=$(VERSION)-dev	$(GO) build $(LDFLAGS) -o bin/${NAME} ./cmd/cli/
+	VERSION=$(VERSION)-dev $(GO) build $(LDFLAGS) -o bin/${NAME} ./cmd/cli/
 
 release: clean
 	mkdir -p _build

README.md

@@ -1,8 +1,31 @@
+## Contributors
+
+Help wanted! 
+
+For implementation clients in search for developers how have skills in Android, iOS, Web or Desktop development.
+
 ## Public storage public key
 
-Simple in-memory public storage public key.
+Specific storage for sharing public keys of pair ECDH by curve25519.
+
+Service provide HTTP API for save and read a 32-bytes key with human-readable name (aka. alias).
+
+This service solve problem for persistent saving public key and send to recipient through open communication channel.
 
-HTTP-base key-value storage.
+### Features
+
+- [x] save public key with name
+- [x] load public key by name
+- [ ] share some encrypted data via one-time link
+- [ ] support other elliptic curve cryptography algorithms
+- [ ] ephemeral encryption via API method
+- [ ] verification of signature by link
+- [ ] QR codes
+- [ ] simple cli tool
+- [ ] simple web-application
+- [ ] simple iOS client
+- [ ] simple android client
+- [ ] local http server to pspk API
 
 ## Model
 
@@ -13,21 +36,66 @@ You should use this model:
 	"key":"base64=="
 }
 ```
+where: 
+- `name` - string with length more that 1000 signs
+- `key` - encodeted to base64 32-bytes public key
 
 ## Request
 
 Save public key:
 ```bash
 curl -X POST "https://pspk.now.sh" -d '{"name":"Some.Name","key":"E7+TL112lj1GmJRHf9jT5MZJDgYIhUbtBLc4/ZFMZ5c="}'
+{"access":true,"msg":"added"}
 ```
 
 Read public key:
 ```bash
 curl -X POST "https://pspk.now.sh" -d '{"name":"Some.Name"}'
+{"access":true,"key":"wTaZA5+QeZpby33W2T5uV8TweWaPEZn3clTe5xkmb2M="}
 ```
 
 ## pspk cli usage
 
+`pspk` - console tool which use API to pspk and implement encryption/decryption for one or several recipients.
+
+```
+$ pspk --help
+NAME:
+   pspk - pspk - encrypt you message and send through open communication channel
+
+USAGE:
+   pspk [global options] command [command options] [arguments...]
+
+VERSION:
+   0.1.2
+
+DESCRIPTION:
+   Console tool for encyption/decription data through pspk.now.sh
+
+COMMANDS:
+     publish, p                    --name <NAME> publish
+     secret, s                     secret public_name
+     encrypt, e                    ecnrypt pub_name some message will encrypt
+     ephemeral-encrypt, ee         ee pub_name some message will encrypt
+     decrypt, d                    decrypt pub_name base64==
+     ephemeral-decrypt, ed         ephemeral-decryp pub_name base64==
+     use-current, uc               --name name_pub_key use-current
+     group, g                      --name base_name group
+     start-group, sg               start-group groupName [pubName1 pubName2 ...]
+     finish-group, fg              finish-group groupName pubName1 [pubName2 ...]
+     secret-group, seg             secret-group groupName pubName1 [pubName2 ...]
+     encrypt-group, eg             eg <GROUP_NAME> message
+     ephemeral-encrypt-group, eeg  Encrypt input message with ephemeral key
+     decrypt-group, dg             dg <GROUP_NAME> base64
+     ephemeral-decrypt-group, edg  Decrypt input message with ephemral shared key
+     help, h                       Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --name value   key name
+   --help, -h     show help
+   --version, -v  print the version
+```
+
 ### Generation key pair.
 Will generation private and public keys and publish public pice to pspk.now.sh.
 ```bash
@@ -62,7 +130,7 @@ pspk --name alice start-group base
 pspk --name bob start-group base alice
 pspk --name carol start-group base bob alice
 ```
-The last members finis generate intermediate secrets.
+The last members finish generate intermediate secrets.
 ```bash
 pspk --name daron finish-group base carol bob alice
 ```

cmd/cli/main.go

@@ -35,6 +35,7 @@ func init() {
 	api = pspk.New(baseURL)
 	app = cli.NewApp()
 	app.Name = "pspk"
+	app.Usage = "encrypt you message and send through open communication channel"
 	app.Metadata = map[string]interface{}{"builded": BuildDate}
 	app.Version = Version + "." + Hash
 	app.Description = "Console tool for encyption/decription data through pspk.now.sh"