Merge branch 'master' into feature/subscriptions_tags

README.md

@@ -1,12 +1,12 @@
-# Moira 2.0  [![Build Status](https://travis-ci.org/moira-alert/moira.svg?branch=master)](https://travis-ci.org/moira-alert/moira) [![Coverage Status](https://coveralls.io/repos/github/moira-alert/moira/badge.svg?branch=master)](https://coveralls.io/github/moira-alert/moira?branch=master) [![Documentation Status](https://readthedocs.org/projects/moira/badge/?version=latest)](http://moira.readthedocs.io/en/latest/?badge=latest) [![Telegram](https://img.shields.io/badge/telegram-join%20chat-3796cd.svg)](https://t.me/moira_alert) [![Go Report Card](https://goreportcard.com/badge/github.com/moira-alert/moira)](https://goreportcard.com/report/github.com/moira-alert/moira) 
+# Moira 2.0  [![Build Status](https://travis-ci.org/moira-alert/moira.svg?branch=master)](https://travis-ci.org/moira-alert/moira) [![Coverage Status](https://coveralls.io/repos/github/moira-alert/moira/badge.svg?branch=master)](https://coveralls.io/github/moira-alert/moira?branch=master) [![Documentation Status](https://readthedocs.org/projects/moira/badge/?version=latest)](http://moira.readthedocs.io/en/latest/?badge=latest) [![Telegram](https://img.shields.io/badge/telegram-join%20chat-3796cd.svg)](https://t.me/moira_alert) [![Go Report Card](https://goreportcard.com/badge/github.com/moira-alert/moira)](https://goreportcard.com/report/github.com/moira-alert/moira)
 
 Moira is a real-time alerting tool, based on [Graphite](https://graphite.readthedocs.io) data.
 
 ## Installation
 
 Docker Compose is the easiest way to try:
 
-```
+```bash
 git clone https://github.com/moira-alert/docker-compose.git
 cd docker-compose
 docker-compose pull
@@ -15,7 +15,7 @@ docker-compose up
 
 Feed data in Graphite format to `localhost:2003`:
 
-```
+```bash
 echo "local.random.diceroll 4 `date +%s`" | nc localhost 2003
 ```
 
@@ -27,44 +27,49 @@ Other installation methods are available, see [documentation](https://moira.read
 
 To build and run tests, first get all dependencies:
 
-```
+```bash
 go get github.com/kardianos/govendor
 govendor sync
 ```
 
-To run test use ``go test ./...`` or run [GoConvey](http://goconvey.co/):
+Then you need local redis listening on port 6379.
+Easiest way to get redis is via docker:
 
+```bash
+docker run -p 6379:6379 -d redis:alpine
 ```
+
+To run test use ``go test ./...`` or run [GoConvey](http://goconvey.co/):
+
+```bash
 go get github.com/smartystreets/goconvey
 goconvey
 ```
 
 For full local deployment of all services, including web, graphite and metrics relay (may be slow on first launch) use:
 
-```
+```bash
 docker-compose up
 ```
 
 Before push your changes don't forget about linter:
 
-```
+```bash
 make lint
 ```
 
 ## Getting Started
 
 See our [user guide](https://moira.readthedocs.io/en/latest/user_guide/index.html) that is based on a number of real-life scenarios, from simple and universal to complicated and specific.
 
-
-## Why 2.0?
+## Why 2.0
 
 Moira 2.0 is different from the first version in two important ways:
 
 1. We got rid of Python, because it was slow. Checker and API services are now written in Go, based on [carbonapi](https://github.com/go-graphite/carbonapi) implementation of Graphite functions.
 2. We got rid of Angular, because our main stack is React now. We just don't know how to do Angular anymore. We also revamped the UI.
 
-
-## What is in the other repositories?
+## What is in the other repositories
 
 Code in this repository is the backend part of Moira monitoring application.
 
@@ -73,12 +78,10 @@ Code in this repository is the backend part of Moira monitoring application.
 * [moira-trigger-role](https://github.com/moira-alert/moira-trigger-role) is the Ansible role you can use to manage triggers.
 * [python-moira-client](https://github.com/moira-alert/python-moira-client) is the Python API client.
 
-
 ## Contact us
 
 If you have any questions, you can ask us on [Telegram](https://t.me/moira_alert).
 
-
 ## Thanks
 
 ![SKB Kontur](https://kontur.ru/theme/ver-1652188951/common/images/logo_english.png)