From 1fe4db7420aeed7bb14c9c06e0c357a9291a27c7 Mon Sep 17 00:00:00 2001
From: Jordan Doyle <jordan@doyle.la>
Date: Fri, 15 Feb 2019 23:08:02 +0000
Subject: [PATCH] Update README.md

---
 README.md | 42 ++++++++++++++++++++++++++++--------------
 1 file changed, 28 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 6606131..9d7f6bb 100644
--- a/README.md
+++ a/README.md
@@ -1,33 +1,47 @@
-# bin.
-a pastebin.
+# bin
+a paste bin.
 
+A paste bin that's actually minimalist. No database requirement, no commenting functionality, no self-destructing or time bomb messages and no social media integration—just an application to quickly send snippits of text to people.
 
+[bin](https://bin.doyle.la/) is written in Rust in around 100 lines of code. It's fast, it's simple, there's code highlighting and you can ⌘+A without going to the 'plain' page. It's revolutionary in the paste bin industry, disrupting markets and pushing boundaries never seen before.
 
-There's no good open source pastebin solutions. I'm sorry to everyone who has one on GitHub but I have to say it. We try to cram as many little features as humanly possible into them and still try and call them minimalist. I don't want to run Redis, I don't want commenting functionality, I don't want self-destructing or time bomb messages and I especially don't want social media integration—I don't know about you but normally I just need to send a quick little snippit of code to someone, it doesn't need a title and I don't *really* mind when it disappears as long as its around long enough for them to see. Honestly, [I'm guilty of it myself](https://github.com/w4/hidden-note), we've all made a pastebin at one point or another but when it comes to making one to release to the public we create abominations.
+##### so how do you get bin?
 
-[bin.](https://bin.doyle.la/) is written in Rust in around 100 lines of code. It's fast, it's simple, there's code highlighting and you can ⌘+A without going to the 'plain' page. Revolutionary in the pastebin industry, disrupting markets and pushing boundaries never seen before.
+Download the latest version from the [releases](https://github.com/w4/bin/releases) page, extract it and run the `./bin` executable. You can compile it from source using Cargo:
 
-##### curl support?
-
 ```bash
-$ curl -X PUT --data 'hello world' bin.doyle.la
-https://bin.doyle.la/cateettary
-$ curl https://bin.doyle.la/cateettary
-hello world
+# nix-shell provides an environment with rust/cargo installed
+$ nix-shell
+
+[nix-shell:~/Code/bin]$ cargo build --release
+   Compiling bin v1.0.0 (/Users/jordanjd/Code/bin)
+    Finished release [optimized] target(s) in 3.61s
+
+[nix-shell:~/Code/bin]$ ./target/release/bin
+    ...
 ```
 
-##### how do you run bin?
+##### how do you run it?
 
 ```bash
 $ ./bin
 ```
 
-##### good one, what settings are there?
+##### funny, what settings are there?
 
-bin. uses [rocket](https://rocket.rs) so you can add a [rocket config file](https://api.rocket.rs/v0.3/rocket/config/) if you like. You can set `ROCKET_PORT` in your environment if you want to change the default port (8820).
+bin uses [rocket](https://rocket.rs) so you can add a [rocket config file](https://api.rocket.rs/v0.3/rocket/config/) if you like. You can set `ROCKET_PORT` in your environment if you want to change the default port (8820).
 
 bin's only configuration value is `BIN_BUFFER_SIZE` which defaults to 2000. Change this value if you want your bin to hold more pastes.
+
+##### is there curl support?
+
+```bash
+$ curl -X PUT --data 'hello world' bin.doyle.la
+https://bin.doyle.la/cateettary
+$ curl https://bin.doyle.la/cateettary
+hello world
+```
 
 ##### how does syntax highlighting work?
 
-To get syntax highlighting you need to add the file extension at the end of your paste URL.+To get syntax highlighting you need to add the file extension at the end of your paste URL.
--
rgit 0.1.3