From df62bf16e160358c8c840ce9736aa9a959322f2c Mon Sep 17 00:00:00 2001 From: Denys Vitali Date: Fri, 17 Feb 2017 17:28:09 +0100 Subject: [PATCH] Add installation, requirements, usage --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a2579d3..76dcee1 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ # megadecrypter -TODO: Write a description here +This app decrypts `mega://enc2` links passed as an argument + +## Requirements +- [Crystal](https://crystal-lang.org) ## Installation -TODO: Write installation instructions here +1. `git clone https://github.com/denysvitali/megadecrypter/` +2. `cd megadecrypter` +3. `crystal build --release src/megadecrypter.cr` -## Usage +If you want to install it permanently: +4. `sudo mv ./megadecrypter /usr/bin/` +5. `sudo chmod 755 /usr/bin/megadecrypter; sudo chown root:root /usr/bin/megadecrypter` -TODO: Write usage instructions here +If you want to run it just once: +4. `./megadecrypter` -## Development +## Usage -TODO: Write development instructions here +`megadecrypter "mega://enc2?encryptedString"` ## Contributing -1. Fork it ( https://github.com/[your-github-name]/megadecrypter/fork ) +1. Fork it ( https://github.com/denysvitali/megadecrypter/fork ) 2. Create your feature branch (git checkout -b my-new-feature) 3. Commit your changes (git commit -am 'Add some feature') 4. Push to the branch (git push origin my-new-feature) @@ -24,4 +32,4 @@ TODO: Write development instructions here ## Contributors -- [[your-github-name]](https://github.com/[your-github-name]) Denys Vitali - creator, maintainer +- [denysvitali](https://github.com/denysvitali) Denys Vitali - creator, maintainer