docs: added readme

This commit is contained in:
əlemi 2023-11-14 06:15:28 +01:00
parent 05fde380f9
commit 6726a69379
Signed by: alemi
GPG key ID: A4895B84D311642C

26
README.md Normal file
View file

@ -0,0 +1,26 @@
# mood
this is a silly little project to model my volatile mood
can you [find](https://api.alemi.dev/mood) all my rare moods?
## how it works
it loads a file containing one entry per line, with its weight prepended:
```
10 option 1
1 option 2
100 option 3
```
then picks one option at random respecting weights (meaning, it's 100x more likely to get option3 than option2)
it will print the result to stdout as headers, newline, body (because it's a CGI script, probably run it under fcgiwrap)
important caveat: the random index changes once every minute and is always unique (it will be echoed in the response)
## why it's cool
this bin has no dependencies!
also cgi is cool, for such a simple project and since i already had fcgiwrap set up, i could get this going in so little lines!
also it's cool because i made it with love (: