From c3d5419028ec7864ac4c8b1483126309d2368849 Mon Sep 17 00:00:00 2001 From: Qstick Date: Thu, 2 Nov 2017 21:03:14 -0400 Subject: [PATCH] Update README.md --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9b85b3d2f..281db1cb0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## Lidarr +# Lidarr [![Build status](https://ci.appveyor.com/api/projects/status/tpm5mj5milne88nc?svg=true)](https://ci.appveyor.com/project/lidarr/lidarr) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/4e6d014aee9542189b4abb0b1439980f)](https://www.codacy.com/app/Lidarr/Lidarr?utm_source=github.com&utm_medium=referral&utm_content=lidarr/Lidarr&utm_campaign=Badge_Grade) @@ -13,31 +13,40 @@ Lidarr is a music collection manager for Usenet and BitTorrent users. It can mon * Can watch for better quality of the tracks you already have and do an automatic upgrade. * Automatic failed download handling will try another release if one fails * Manual search so you can pick any release or to see why a release was not downloaded automatically -* Fully configurable episode renaming +* Fully configurable track renaming * Full integration with SABnzbd and NZBGet * Full integration with Kodi, Plex (notification, library update, metadata) -* Full support for specials and multi-episode releases +* Full support for specials and multi-album releases * And a beautiful UI ## Feature Requests [![Feature Requests](http://feathub.com/lidarr/Lidarr?format=svg)](http://feathub.com/lidarr/Lidarr) +## Support + +[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60)](https://discord.gg/8Y7rDc9) +[![Reddit](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60)](https://www.reddit.com/r/lidarr) +[![GitHub](https://img.shields.io/badge/github-issues-red.svg?maxAge=60)](https://github.com/Lidarr/Lidarr/issues) +[![GitHub Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60)](https://github.com/Lidarr/Lidarr/wiki) + ## Configuring Development Environment: ### Requirements -* Visual Studio 2015 or higher (https://www.visualstudio.com/vs/). The community version is free and works (https://www.visualstudio.com/downloads/). +* Visual Studio 2017 or higher (https://www.visualstudio.com/vs/). The community version is free and works (https://www.visualstudio.com/downloads/). * [Git](https://git-scm.com/downloads) -* [NodeJS](https://nodejs.org/en/download/) (Node 6.X.X, NPM 3.X.X Recommended) +* [NodeJS](https://nodejs.org/en/download/) (Node 6.X.X or higher) +* [Yarn](https://yarnpkg.com/) ### Setup * Make sure all the required software mentioned above are installed. * Clone the repository into your development machine. [*info*](https://help.github.com/articles/working-with-repositories) * 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. +* Install the required Node Packages `yarn install` +* Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command. +* Build the project in Visual Studio * Run the project in Visual Studio * Open http://localhost:8686