diff options
| author | Azul <azul@riseup.net> | 2017-10-11 15:57:39 +0200 |
|---|---|---|
| committer | Azul <azul@riseup.net> | 2017-10-11 15:57:39 +0200 |
| commit | 61ebd2908da912ee269dbeb71b5bddc2b50efbb2 (patch) | |
| tree | 14adbb5c9d601648d91faef2175c124582789cb8 | |
| parent | 726c035b7b7fac636982ac6e4c28e199d4c8cc8a (diff) | |
docs: update README.md
* We are using Celluloid instead of EventMachine now
* The json responses are currently not signed
* we actually pick a key rather than sending all available
* There are only two install options listed. We were claiming there are three.
| -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 |