add readme

Needs a hosting guide too.

Signed-off-by: Gunwant Jain <mail@wantguns.dev>
This commit is contained in:
Gunwant Jain 2020-12-30 04:37:30 +05:30
parent ea790a066a
commit 27f84bbe3b
2 changed files with 37 additions and 1 deletions

36
readme Normal file
View File

@ -0,0 +1,36 @@
USAGE
-----
POST /
accepts raw data in the body of the request and responds with a URL
of a page containing the body's content
GET /<id>
retrieves the content for the paste with id `<id>`
GET /p/<id>
retrieves the HTML page with syntax-highlighted content for the paste with id `<id>`
EXAMPLES
--------
Paste a file named 'file.txt' using cURL:
curl -d@file.txt https://bin.wantguns.dev
Paste from stdin using cURL:
echo "Hello, world." | curl -d@- https://bin.wantguns.dev
Add this to your .zshrc to implement a quicker usage.
function paste() {
local file=${1:-/dev/stdin}
curl -d@${file} https://bin.wantguns.dev
}
If the uploaded data binary is parsed as "text/*", then the paste will be syntax
highlighted

View File

@ -69,7 +69,7 @@ fn upload(paste: Data) -> Result<String, std::io::Error> {
#[get("/")]
fn index() -> &'static str {
"\
"
USAGE
-----