From dc9cb2642be55917f3b921420bb6bbe251571620 Mon Sep 17 00:00:00 2001 From: sose Date: Fri, 18 Oct 2019 00:46:21 -0400 Subject: [PATCH 1/3] Update 'README.md' --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb8af32..296074f 100644 --- a/README.md +++ b/README.md @@ -43,13 +43,21 @@ currently there is: - this function is expected to continuously output post data it receives like so: ``` New post + board: + parent: + user: + title: + content:<content> + image_name:<name of image> + image content:<base64 encoded image> + End new post ``` - as long as the backend has a listen function that outputs data to stdout like this, @@ -58,7 +66,7 @@ End new post - a db backend is simply a shell script providing the following functions: - `path_to_post <post id>` - `create post <board> <parent> <user> <title> <content> <image_name> <image_content> <post_id> <post_type>` - - `get_post_data <post_data_path> <item> + - `get_post_data <post_data_path> <item>` - note that since these functions are both in the same file, `post_data_path` can be in any format you desire - again, shi doesn't care how this is done, only that it follows this format From 18b3290b23942c490f6e351b6b3637f661217cd9 Mon Sep 17 00:00:00 2001 From: sose <oneseveneight@airmail.cc> Date: Fri, 18 Oct 2019 00:47:12 -0400 Subject: [PATCH 2/3] Update 'README.md' --- README.md | 28 +++++++++------------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 296074f..57503ee 100644 --- a/README.md +++ b/README.md @@ -41,25 +41,15 @@ currently there is: - **listening** - a backend is a shell script with a `listen` function - this function is expected to continuously output post data it receives like so: -``` -New post - -board:<board name> - -parent:<parent of post> - -user:<user> - -title:<title> - -content:<content> - -image_name:<name of image> - -image content:<base64 encoded image> - -End new post -``` + New post + board:<board name> + parent:<parent of post> + user:<user> + title:<title> + content:<content> + image_name:<name of image> + image content:<base64 encoded image> + End new post - as long as the backend has a listen function that outputs data to stdout like this, shi doesn't care where it comes from. - **db** From 5a14ebf25f719d78b55089615c9835d7ffd60120 Mon Sep 17 00:00:00 2001 From: sose <oneseveneight@airmail.cc> Date: Fri, 18 Oct 2019 00:48:14 -0400 Subject: [PATCH 3/3] Update 'README.md' --- README.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 57503ee..71ebf07 100644 --- a/README.md +++ b/README.md @@ -40,17 +40,8 @@ currently there is: - **how backends work** - **listening** - a backend is a shell script with a `listen` function - - this function is expected to continuously output post data it receives like so: - New post - board:<board name> - parent:<parent of post> - user:<user> - title:<title> - content:<content> - image_name:<name of image> - image content:<base64 encoded image> - End new post - - as long as the backend has a listen function that outputs data to stdout like this, + - this function is expected to continuously output post data it receives + - as long as the backend has a listen function that continuously outputs data to stdout in the proper format, shi doesn't care where it comes from. - **db** - a db backend is simply a shell script providing the following functions: