From 4fd77ac95998a9bff45e30a26f97e60159ad5e1d Mon Sep 17 00:00:00 2001 From: Niklas Halle Date: Sun, 23 Aug 2020 13:57:40 +0200 Subject: added crow and basic example --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c540718..3e598b9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # N Core - the backend of N + +Build upon [crow](https://github.com/ipkn/crow) [forked](https://git.niklashalle.net/crow) to fix a deprecation in boost 1.7+ + ## N protocol ### request -Each message sent to the N core server must be valid JSON and have a `command` field. It contains the command for N to handle, sanitizied (i.e. no leading '/' or trailing username etc). +Each message sent to the N core server must be valid JSON and have a `command` field. It contains the command for N to handle, sanitized (i.e. no leading '/' or trailing username etc). The arguments field contains the remaining text just as was send to the bridge. -All messages may optionally include an `session` field. When you authorize against N core or switch to a menu, you will be returned (see next section) a session id which you can then send with this field to follow up on the inital command. +All messages may optionally include an `session` field. When you authorize against N core or switch to a menu, you will be returned (see next section) a session id which you can then send with this field to follow up on the initial command. | Field | Type | Required? | Description | |-------|------|-----------|-------------| -- cgit v1.2.3-54-g00ecf