Create README.md

joek13 · Jun 10, 2017 · d4f7833 · d4f7833
1 parent d8658cf
commit d4f7833
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# hastebin-client
+A CLI client for hastebin.com written in Rust.
+Currently, it only supports uploading of files. You can optionally open newly opened files in a new browser window using `--open`.
+
+## Building / Installing
+1. Make sure you have [https://www.rust-lang.org/en-US/](Rust) installed.
+2. Clone the repo.
+3. Enter the directory and run `cargo build --release` (the `--release` flag enables compile-time optimizations)
+4. Enter the newly created `target/release` folder and copy the `hastebin-client` binary into `/usr/bin` or put it somewhere safe and add it to your PATH.
+5. You're done! Optionally, add the following to your `vim` config file to create a custom command to upload the currently open file.
+```
+:command Haste !hastebin-client upload --open "%"
+```