diff --git a/README.md b/README.md index d1cfa48..3e6a144 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ Rdcli === -[![npm version](https://badge.fury.io/js/rdcli.svg)](https://badge.fury.io/js/rdcli) -[![Build Status](https://travis-ci.org/ston3o/rdcli.svg?branch=master)](https://travis-ci.org/ston3o/rdcli/) -[![npm download](https://img.shields.io/npm/dt/rdcli.svg)](https://www.npmjs.com/package/rdcli) -[![Code Climate](https://codeclimate.com/github/ston3o/rdcli/badges/gpa.svg)](https://codeclimate.com/github/ston3o/rdcli) +[![](https://img.shields.io/github/tag/ston3o/rdcli.svg?label=version&style=flat-square&colorA=0d7377&colorB=44c2c7)](https://github.com/ston3o/rdcli/releases) +[![](https://img.shields.io/badge/license-GPL%20v3%2B-yellow.svg?style=flat-square&colorA=0d7377&colorB=44c2c7)](https://raw.githubusercontent.com/ston3o/rdcli/master/LICENSE.txt) +[![](https://img.shields.io/travis/ston3o/rdcli.svg?style=flat-square&colorA=0d7377&colorB=44c2c7)](https://travis-ci.org/ston3o/rdcli/branches) +[![](https://img.shields.io/codeclimate/maintainability/ston3o/rdcli.svg?style=flat-square&colorA=0d7377&colorB=44c2c7)](https://codeclimate.com/github/ston3o/rdcli) +[![](https://img.shields.io/badge/donate-liberapay-blue.svg?style=flat-square&colorA=0d7377&colorB=44c2c7)](https://liberapay.com/ston3o/donate) +[![](https://img.shields.io/npm/dt/rdcli.svg?style=flat-square&colorA=0d7377&colorB=44c2c7)](https://www.npmjs.com/package/rdcli) > The simple way to download and unrestrict DDL files, torrents and magnets. @@ -12,7 +14,9 @@ Rdcli ## Installation -`npm install --global rdcli` +```bash +npm install --global rdcli +``` And set your real-debrid account as enviroment variable on your `~/.bashrc` @@ -23,37 +27,26 @@ export REALDEBRID_PASSWORD=your_password ## Usage -`rdcli ` - -Download DDL file: - -`rdcli http://uptobox.com/1gdncohxbqkp` - -Download magnet file: - -`rdcli 'magnet:?xt=urn:btih:33130de5c14a8bb5410746ee5a9604cdfb9538ef'` - -Download torrent file: - -`rdcli Back.to.the.Future.Trilogy.1080p.BluRay.x264.torrent` - -## Development +```bash +rdcli +``` -Install dependencies: +## Running the tests -`make install` +```bash +make test +``` -Start project: +## Support -`make run` +Support me with a monthly donation and help me continue my activities: -Run tests: +[![liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/ston3o/donate) -`make test` +Buy me a beer (BTC): [bitcoin:112aZxX9Jiya4TM6Le4foxTq9V8U6aVGbG](112aZxX9Jiya4TM6Le4foxTq9V8U6aVGbG) -License ---- +## License -GNU GPL v3.0 +This project is licensed under the GNU GPL v3.0 - see the [LICENSE.txt](LICENSE.txt) file for details **Free Software, Hell Yeah!**