diff options
author | Niklas Halle <niklas@niklashalle.net> | 2020-08-23 13:57:40 +0200 |
---|---|---|
committer | Niklas Halle <niklas@niklashalle.net> | 2020-08-23 13:58:02 +0200 |
commit | 4fd77ac95998a9bff45e30a26f97e60159ad5e1d (patch) | |
tree | bd17e8f07cef20364bde750385a41d58f905d768 /README.md | |
parent | 3314a53d0cf0a135fe6f82fcc7b6f4df84f70436 (diff) | |
download | n_core-4fd77ac95998a9bff45e30a26f97e60159ad5e1d.tar.gz n_core-4fd77ac95998a9bff45e30a26f97e60159ad5e1d.zip |
added crow and basic example
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 7 |
1 files changed, 5 insertions, 2 deletions
@@ -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 | |-------|------|-----------|-------------| |