From 30e768b45ca698c677323e1fc3a3462f9c5bba49 Mon Sep 17 00:00:00 2001
From: Denis Nikolas <design.by.niko.las@gmail.com>
Date: Tue, 16 Jul 2019 20:33:35 +0500
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a6dd1f1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Vkontakte auth for Flarum
+
+This is simple auth with vk.com OAuth2.0.
+When register it translitirate any cyrillic names to latin, and set user avatar.
+
+### installation
+
+Install manually:
+
+```bash
+composer require nikovonlas/flarum-ext-auth-vk
+
+```
+
+### configuration
+
+Don't forget to activate the extension in the admin panel of your Flarum, and use the Settings dialog to configure the extension!