From a03e6513cbc252daff5874bd028cb470690c5bc8 Mon Sep 17 00:00:00 2001
From: Valentin Popov <info@valentineus.link>
Date: Thu, 26 Mar 2020 21:44:40 +0400
Subject: feat(project): Updated "README.md"

Signed-off-by: Valentin Popov <info@valentineus.link>
---
 README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index fbbcddd..d2dc37c 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,56 @@
 # Personal ESLint configuration
+
+## Configurations
+
+* `javascript`
+* `typescript`
+* `vue-javascript`
+* `vue-typescript`
+
+## Example
+
+* Install dependencies:
+
+```shell script
+npm install --save-dev @typescript-eslint/eslint-plugin @typescript-eslint/parser         \
+                       @valentineus/eslint-config eslint eslint-plugin-eslint-comments    \
+                       eslint-plugin-import eslint-plugin-security eslint-plugin-sonarjs  \
+                       eslint-plugin-unicorn eslint-plugin-vue
+ 
+# or
+yarn add --dev @typescript-eslint/eslint-plugin @typescript-eslint/parser         \
+               @valentineus/eslint-config eslint eslint-plugin-eslint-comments    \
+               eslint-plugin-import eslint-plugin-security eslint-plugin-sonarjs  \
+               eslint-plugin-unicorn eslint-plugin-vue
+```
+
+* Create config file:
+
+```json
+{
+  "env": {
+    "browser": true,
+    "es6": true
+  },
+  "extends": [
+    "@valentineus/eslint-config/vue-typescript"
+  ],
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly"
+  },
+  "parserOptions": {
+    "createDefaultProgram": true,
+    "ecmaVersion": 2020,
+    "project": "tsconfig.json",
+    "sourceType": "module",
+    "tsconfigRootDir": "."
+  },
+  "rules": {}
+}
+```
+
+## License
+
+[Apache-2.0](LICENSE.txt).
+Copyright (c) [Valentin Popov](mailto:info@valentineus.link).
-- 
cgit v1.2.3