From de83867a767f3bb2168b8875f5bf2edfa33c3f12 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=D0=98=D0=BB=D1=8C=D1=8F=20=D0=9B=D0=B5=D0=B1=D0=B5=D0=B4?=
 =?UTF-8?q?=D0=B5=D0=B2?= <i.lebedev@bestdoctor.ru>
Date: Thu, 7 Feb 2019 14:58:29 +0300
Subject: [PATCH] add readme

---
 README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)

diff --git a/README.md b/README.md
index e69de29..8d31f38 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,59 @@
+# flake8-annotations-complexity
+
+
+[![Build Status](https://travis-ci.org/best-doctor/flake8-variables-names.svg?branch=master)](https://travis-ci.org/best-doctor/flake8-variables-names)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c7502e578af3f4437179/maintainability)](https://codeclimate.com/github/best-doctor/flake8-variables-names/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c7502e578af3f4437179/test_coverage)](https://codeclimate.com/github/best-doctor/flake8-variables-names/test_coverage)
+
+An extension for flake8 that helps to make more readable variables names.
+
+We believe, that variable name should unmistakably shows, what it contains.
+Thats why we try not to use varnames with only one symbol or not to use
+too common names, such as `result`, `value` or `info`.
+
+This extensions helps to detect such names. By default it works in
+non-strict mode. You can change it with `--use-varnames-strict-mode`
+parameter end extend variable names blacklist even more.
+
+## Installation
+
+    pip install flake8-variables-names
+
+
+## Example
+
+Sample file:
+
+```python
+# test.py
+
+a = 1
+foo = 2
+result = a + foo
+```
+
+Usage:
+
+```terminal
+$ flake8 test.py
+test.py:1:1: VNE001 single letter variable names are not allowed
+test.py:2:1: VNE002 variable name should be clarified
+```
+
+Tested on Python 3.6 and flake8 3.5.0.
+
+
+## Contributing
+
+We would love you to contribute to our project. It's simple:
+
+1. Create an issue with bug you found or proposal you have. Wait for approve from maintainer.
+2. Create a pull request. Make sure all checks are green.
+3. Fix review comments if any.
+4. Be awesome.
+
+Here are useful tips:
+
+- You can run all checks and tests with `make check`. Please do it before TravisCI does.
+- We use [BestDoctor python styleguide](https://github.com/best-doctor/guides/blob/master/guides/python_styleguide.md). Sorry, styleguide is available only in Russian for now.
+- We respect [Django CoC](https://www.djangoproject.com/conduct/). Make soft, not bullshit.