This commit is contained in:
sose 2019-11-05 12:08:53 -05:00
commit b82ddcc207
1 changed files with 3 additions and 14 deletions

View File

@ -40,25 +40,14 @@ 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:
- `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