From 394b4f0bf7f2a4d496ffe69c8e30cff153d69532 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 14 Jan 2016 20:00:50 +0100 Subject: Simplify example instructions and fix broken examples Also convert to AsciiDoc while we're at it. --- examples/rest_pastebin/README.asciidoc | 47 ++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 examples/rest_pastebin/README.asciidoc (limited to 'examples/rest_pastebin/README.asciidoc') diff --git a/examples/rest_pastebin/README.asciidoc b/examples/rest_pastebin/README.asciidoc new file mode 100644 index 0000000..d0cabc1 --- /dev/null +++ b/examples/rest_pastebin/README.asciidoc @@ -0,0 +1,47 @@ += REST pastebin example + +To try this example, you need GNU `make` and `git` in your PATH. + +To build and run the example, use the following command: + +[source,bash] +$ make run + +Then point your browser to http://localhost:8080 + +== Usage + +To upload something to the paste application, you can use `curl`: + +[source,bash] +$ | curl -i --data-urlencode paste@- localhost:8080 + +Or, to upload the file `my_file`: + +[source,bash] +curl -i --data-urlencode paste@my_file localhost:8080 + +The URL of your data will be in the location header. Alternately, you can visit +http://localhost:8080 with your favorite web browser and submit your paste via +the form. + +Code that has been pasted can be highlighted with ?lang= option if +you have http://www.andre-simon.de/doku/highlight/en/highlight.html[highlight] +installed (although `pygments` or any other should work just fine). + +This will show the contents of the HTML file: + +[source,bash] +curl -i --data-urlencode paste@priv/index.html localhost:8080 +curl + +If your terminal supports color sequences and `highlight` is installed, +the following command will show the same contents but with HTML syntax +highlighting. + +[source,bash] +curl ?lang=html + +If you open the same URL in your web browser and your web browser tells +Cowboy that it prefers HTML files, you will see the file highlighted +with special HTML markup and CSS. Firefox is known to work. -- cgit v1.2.3