sose/shi
1
2
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update 'README.md'

Browse Source
This commit is contained in:
sose 2019-10-18 00:46:21 -04:00
parent c46b15f228
commit dc9cb2642b
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -43,13 +43,21 @@ currently there is:
- this function is expected to continuously output post data it receives like so: - this function is expected to continuously output post data it receives like so:
``` ```
New post New post
board:<board name> board:<board name>
parent:<parent of post> parent:<parent of post>
user:<user> user:<user>
title:<title> title:<title>
content:<content> content:<content>
image_name:<name of image> image_name:<name of image>
image content:<base64 encoded image> image content:<base64 encoded image>
End new post End new post
``` ```
- as long as the backend has a listen function that outputs data to stdout like this, - 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: - a db backend is simply a shell script providing the following functions:
- `path_to_post <post id>` - `path_to_post <post id>`
- `create post <board> <parent> <user> <title> <content> <image_name> <image_content> <post_id> <post_type>` - `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 - 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 - again, shi doesn't care how this is done, only that it follows this format