diff options
| author | azul <azul@riseup.net> | 2017-11-07 08:20:41 -0800 |
|---|---|---|
| committer | azul <azul@riseup.net> | 2017-11-07 08:20:41 -0800 |
| commit | a43e647663100b7a5117008641765d3508edbe5b (patch) | |
| tree | 6e415b50e29d8c36f84c0d477fe12b3ee2ee1123 /README.md | |
| parent | fac140a8ff76e98c275194845125d4c97f4ba07b (diff) | |
| parent | 85a567286cf61a3a8193c339dd0967116d79299c (diff) | |
Merge branch 'refactor/clarify-response' into 'master'
Refactor/clarify response
See merge request leap/nickserver!20
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 5 insertions, 6 deletions
@@ -17,17 +17,18 @@ About nickserver: * Written in Ruby 2.1, licensed GPLv3 * Lightweight and scalable (high concurrency, reasonable latency) -* Uses asynchronous network IO for both server and client connections (via EventMachine) +* Uses asynchronous network IO for both server and client connections + (via Celluloid IO) API ================================== -You query the nickserver via HTTP. The API is very minimal: +You send requests to nickserver via HTTP. The API is very minimal: curl -X POST -d address=alice@domain.org https://nicknym.domain.org:6425 -The response consists of a signed JSON document with fields for the available -public keys corresponding to the address. +The response consists of a JSON document with fields for the selected +public key corresponding to the address. For more details, see https://leap.se/nicknym @@ -40,8 +41,6 @@ Requirements Installation ================================== -You have three fine options for installing nickserver: - Install prerequisites $ sudo apt-get install ruby-dev libssl-dev |