summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/README.md b/README.md
index dceb7e4..8a61d89 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,23 @@
-## binit -- minimal pastebin-like in 100 lines of golang
+## binit -- minimal pastebin-like in golang
That's just it. Preliminary version of a minimal, no-fuss
pastebin-like service in golang.
-Needs a folder "pastes/" to exist on the same dir where the program is
-run from. At the moment, it binds on `localhost:8000` and serves
-pastes in the format:
+It serves pastes in the format:
- localhost:8000/abcdef1234567890
+ mypasteserver.org/abcdef1234567890
-The unique ID of a paste is obtained from the SHA256 of the
-concatenation of title, time, and content. Rendering is minimal, but
-can be enhanced.
+and stores them in a folder, one file per paste, whose filename is
+equal to the paste ID. The unique ID of a paste is obtained from the
+SHA256 of the concatenation of title, time, and content. Rendering is
+minimal, but can be enhanced.
`binit` is currently configured through a simple key=value
configuration file. The available options are:
-* host (the hostname to listen on)
-* port (the port to bind)
+* server\_name (the FQDN where the service is reachable from outside)
+* bind\_addr (the address to listen on)
+* bind\_port (the port to bind)
* paste\_dir (the folder where pastes are kept)
* templ\_dir (the folder where HTML files and templates are kept)
* max_size (the maximum allowed length of a paste, in bytes. Larger
@@ -26,4 +26,4 @@ configuration file. The available options are:
### TODO
-* Add a simple template system
+* reorganise the code for paste storage/retrieve