Skip to content

Commit

Permalink
Add installation, requirements, usage
Browse files Browse the repository at this point in the history
  • Loading branch information
Denys Vitali committed Feb 17, 2017
1 parent 32ea2f6 commit df62bf1
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
@@ -1,27 +1,35 @@
# 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)
5. Create a new Pull Request

## Contributors

- [[your-github-name]](https://github.com/[your-github-name]) Denys Vitali - creator, maintainer
- [denysvitali](https://github.com/denysvitali) Denys Vitali - creator, maintainer

0 comments on commit df62bf1

Please sign in to comment.