Create README.md

NikoVonLas · Jul 16, 2019 · 30e768b · 30e768b
1 parent 7d6b2db
commit 30e768b
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md 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!