From f63c3091f4507533e5487200826ad37274970ed1 Mon Sep 17 00:00:00 2001 From: hotio Date: Sun, 15 Jan 2017 13:50:45 +0100 Subject: [PATCH] Reworked README (#280) --- README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 068ec561d..1a6ccd091 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -# Radarr +## Status + +[![GitHub issues](https://img.shields.io/github/issues/radarr/radarr.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/issues) +[![GitHub pull requests](https://img.shields.io/github/issues-pr/radarr/radarr.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/pulls) +[![GNU GPL v3](https://img.shields.io/badge/license-GNU%20GPL%20v3-blue.svg?maxAge=60&style=flat-square)](http://www.gnu.org/licenses/gpl.html) +[![Copyright 2010-2017](https://img.shields.io/badge/copyright-2017-blue.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr) | Service | Master | Develop | |----------|:---------------------------:|:----------------------------:| @@ -7,22 +12,21 @@ This fork of Sonarr aims to turn it into something like CouchPotato. -## Download +## Downloads -Release builds can be found on: -* [GitHub](https://github.com/Radarr/Radarr/releases) +[![GitHub Releases](https://img.shields.io/badge/downloads-releases-brightgreen.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/releases) -Continuous builds can be found on: -* [AppVeyor](https://ci.appveyor.com/project/galli-leo/radarr-usby1/build/artifacts) +[![AppVeyor Builds](https://img.shields.io/badge/downloads-continuous-green.svg?maxAge=60&style=flat-square)](https://ci.appveyor.com/project/galli-leo/radarr-usby1/build/artifacts) -Docker containers from [linuxserver.io](http://tools.linuxserver.io/dockers) can be found here: -* [x64](https://store.docker.com/community/images/linuxserver/radarr) -* [armhf](https://store.docker.com/community/images/lsioarmhf/radarr) -* [aarch64](https://store.docker.com/community/images/lsioarmhf/radarr-aarch64) +[![Docker x64](https://img.shields.io/badge/docker-x64-blue.svg?maxAge=60&style=flat-square)](https://store.docker.com/community/images/linuxserver/radarr) +[![Docker armhf](https://img.shields.io/badge/docker-armhf-blue.svg?maxAge=60&style=flat-square)](https://store.docker.com/community/images/lsioarmhf/radarr) +[![Docker aarch64](https://img.shields.io/badge/docker-aarch64-blue.svg?maxAge=60&style=flat-square)](https://store.docker.com/community/images/lsioarmhf/radarr-aarch64) To connect to the UI, fire up your browser and open or . -## Currently Working +## Features + +### Currently Working * Adding new movies * Manually searching for releases of movies @@ -34,13 +38,13 @@ To connect to the UI, fire up your browser and open or < * QBittorrent and Deluge download client (Other clients are coming) * New TorrentPotato Indexer (Works well with [Jackett](https://github.com/Jackett/Jackett)) -## Planned Features +### Planned Features * Scanning PreDB to know when a new release is available * Fixing the other Indexers and download clients * Importing of Sonarr config -## Major Features +### Major Features * Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc. * Can watch for better quality of the movies you have and do an automatic upgrade. *eg. from DVD to Blu-Ray* @@ -61,7 +65,7 @@ To connect to the UI, fire up your browser and open or < ### Setup * Make sure all the required software mentioned above are installed -* Clone the repository into your development machine ([*info*](https://help.github.com/desktop/guides/contributing/working-with-your-remote-repository-on-github-or-github-enterprise/)) +* Clone the repository into your development machine ([*info*](https://help.github.com/desktop/guides/contributing/working-with-your-remote-repository-on-github-or-github-enterprise)) * Grab the submodules `git submodule init && git submodule update` * Install the required Node Packages `npm install` * Start gulp to monitor your dev environment for any changes that need post processing using `npm start` command. @@ -73,12 +77,7 @@ To connect to the UI, fire up your browser and open or < * Open `NzbDrone.sln` in Visual Studio or run the build.sh script, if Mono is installed * Make sure `NzbDrone.Console` is set as the startup project -### License - -* [GNU GPL v3](http://www.gnu.org/licenses/gpl.html) -* Copyright 2010-2016 - -### Sponsors +## Sponsors [JetBrains](http://www.jetbrains.com) for providing us with free licenses to their great tools: * [ReSharper](http://www.jetbrains.com/resharper)