Update 'README.md'

This commit is contained in:
sose 2019-10-17 01:26:06 -04:00
parent e9beb53e61
commit 758db56586
1 changed files with 11 additions and 10 deletions

View File

@ -19,6 +19,7 @@ the programming equivalent of a shitpost
- `. ./console.sh` to start the shi console
- `start_listener` to start lisenting for posts
- you might want to do `tail -f log.txt` in another terminal to see whats going on
### how backends work
- shi has a builtin framework for swappable backends both for post recieving and storage,
currently there is:
@ -41,15 +42,15 @@ currently there is:
- a backend is a shell script with a `listen` function
- this function is expected to coninuosly output post data it recives 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.
@ -93,7 +94,7 @@ currently there is:
otherwise declare the variable as empty and then set it to your operation
- follow shellcheck
# files n folders
### files n folders
- boards
- where all the html for the boards is stored
- console.sh