correct usage guides

Signed-off-by: Gunwant Jain <mail@wantguns.dev>
This commit is contained in:
Gunwant Jain
2020-12-30 06:35:19 +05:30
parent 27f84bbe3b
commit ef96dcff33
2 changed files with 47 additions and 47 deletions

44
readme
View File

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

View File

@@ -70,43 +70,43 @@ fn upload(paste: Data) -> Result<String, std::io::Error> {
#[get("/")] #[get("/")]
fn index() -> &'static str { fn index() -> &'static str {
" "
USAGE USAGE
----- -----
POST / POST /
accepts raw data in the body of the request and responds with a URL accepts raw data in the body of the request and responds with a URL
of a page containing the body's content of a page containing the body's content
GET /<id> GET /<id>
retrieves the content for the paste with id `<id>` retrieves the content for the paste with id `<id>`
GET /p/<id> GET /p/<id>
retrieves the HTML page with syntax-highlighted content for the paste with id `<id>` retrieves the HTML page with syntax-highlighted content for the paste with id `<id>`
EXAMPLES EXAMPLES
-------- --------
Paste a file named 'file.txt' using cURL: Paste a file named 'file.txt' using cURL:
curl -d@file.txt https://bin.wantguns.dev curl --data-binary @file.txt https://bin.wantguns.dev
Paste from stdin using cURL: Paste from stdin using cURL:
echo \"Hello, world.\" | curl -d@- https://bin.wantguns.dev echo \"Hello, world.\" | curl --data-binary @- https://bin.wantguns.dev
Add this to your .zshrc to implement a quicker usage. Add this to your .zshrc to implement a quicker usage.
function paste() { function paste() {
local file=${1:-/dev/stdin} local file=${1:-/dev/stdin}
curl -d@${file} https://bin.wantguns.dev curl --data-binary @${file} https://bin.wantguns.dev
} }
If the uploaded data binary is parsed as \"text/*\", then the paste will be syntax If the uploaded data binary is parsed as \"text/*\", then the paste will be syntax
highlighted highlighted
" "
} }
fn main() { fn main() {