From a6f5f9034d4901f780302c8c657839959b4f1729 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mike=20San=20Rom=C3=A1n?= <mike@msanroman.io>
Date: Fri, 12 Jun 2020 16:56:17 +0200
Subject: [PATCH] Add README.md

---
 eslint/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 eslint/README.md

diff --git a/eslint/README.md b/eslint/README.md
new file mode 100644
index 0000000..a093921
--- /dev/null
+++ b/eslint/README.md
@@ -0,0 +1,24 @@
+# @bufferapp/eslint-config
+
+This is the standard ESLint config files for the projects within the @bufferapp
+ GitHub organization.
+
+## Usage
+
+```console
+npm install --save-dev @bufferapp/eslint-config eslint
+# or
+yarn add -D @bufferapp/eslint-config eslint
+```
+
+NOTE: We will need to define custom installation instructions for front-end
+ and backend-based configs, depending on those we will have different
+  `peerDependencies` for the ESLint configs.
+
+And then, on your `.eslintrc` use
+
+```
+"extends": "@bufferapp/eslint-config-backend"
+#or
+"extends": "@bufferapp/eslint-config-frontend"
+```