From 61ebd2908da912ee269dbeb71b5bddc2b50efbb2 Mon Sep 17 00:00:00 2001 From: Azul Date: Wed, 11 Oct 2017 15:57:39 +0200 Subject: 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. --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 50460c4..01eaa07 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3