diff options
Diffstat (limited to 'examples/rest_pastebin/README.md')
| -rw-r--r-- | examples/rest_pastebin/README.md | 63 |
1 files changed, 36 insertions, 27 deletions
diff --git a/examples/rest_pastebin/README.md b/examples/rest_pastebin/README.md index 0e9d9b5..525cf39 100644 --- a/examples/rest_pastebin/README.md +++ b/examples/rest_pastebin/README.md @@ -1,29 +1,35 @@ -Cowboy Rest Hello World -======================= +REST pastebin example +===================== -To compile this example you need rebar in your PATH. +To try this example, you need GNU `make`, `git` and +[relx](https://github.com/erlware/relx) in your PATH. -Type the following command: -``` -$ rebar get-deps compile -``` +To build the example, run the following command: -You can then start the Erlang node with the following command: +``` bash +$ make ``` -./start.sh + +To start the release in the foreground: + +``` bash +$ ./_rel/bin/rest_pastebin_example console ``` -Then run any given command or point your browser to the indicated URL. +Then point your browser at [http://localhost:8080](http://localhost:8080). -Examples --------- +Usage +----- -To upload something to the paste application, you can use curl like: -``` -<command> | curl -i --data-urlencode paste@- localhost:8080 -``` -or to upload my_file: +To upload something to the paste application, you can use `curl`: + +``` bash +$ <command> | curl -i --data-urlencode paste@- localhost:8080 ``` + +Or, to upload the file `my_file`: + +``` bash curl -i --data-urlencode paste@my_file localhost:8080 ``` @@ -33,20 +39,23 @@ the form. Code that has been pasted can be highlighted with ?lang=<language> option if you have [highlight](http://www.andre-simon.de/doku/highlight/en/highlight.html) -installed (although pygments or any other should work just fine). For example: -``` +installed (although `pygments` or any other should work just fine). + +This will show the contents of the HTML file: + +``` bash curl -i --data-urlencode paste@priv/index.html localhost:8080 curl <url from location header> ``` -Will show the text of the html file. If your terminal supports color -sequences and highlight is installed: -``` +If your terminal supports color sequences and `highlight` is installed, +the following command will show the same contents but with HTML syntax +highlighting. + +``` bash curl <url from location header>?lang=html ``` -Will show a syntax highlighted version of the source file. 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 html/css markup. Firefox is -known to work. - +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. |