Apply new README format

ogioncz · Sep 21, 2017 · f67c69b · f67c69b
1 parent d804c4a
commit f67c69b
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 40 deletions.
diff --git a/changelog.md → CHANGELOG.md b/changelog.md → CHANGELOG.md
diff --git a/contributing.md → CONTRIBUTING.md b/contributing.md → CONTRIBUTING.md
diff --git a/license.md → LICENSE.md b/license.md → LICENSE.md
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,52 @@
+# Users list by ![Flagrow logo](https://avatars0.githubusercontent.com/u/16413865?v=3&s=20) [Flagrow](https://discuss.flarum.org/d/1832-flagrow-extension-developer-group), a project of [Gravure](https://gravure.io/)
+
+[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/flagrow/users-list/blob/master/LICENSE.md) [![Latest Stable Version](https://img.shields.io/packagist/v/flagrow/users-list.svg)](https://packagist.org/packages/flagrow/users-list) [![Total Downloads](https://img.shields.io/packagist/dt/flagrow/users-list.svg)](https://packagist.org/packages/flagrow/users-list) [![Donate](https://img.shields.io/badge/patreon-support-yellow.svg)](https://www.patreon.com/flagrow) [![Join our Discord server](https://discordapp.com/api/guilds/240489109041315840/embed.png)](https://flagrow.io/join-discord)
+
+A [Flarum](http://flarum.org) extension that adds users list to admin panel.
+
+![Imgur](https://i.imgur.com/JSlVsEn.png)  
+![Imgur](https://i.imgur.com/PIHr4mT.png)  
+
+> The initial version was created by [Avatar4eg](https://github.com/avatar4eg), all credits of that version go to him.
+
+## Installation
+
+Use [Bazaar](https://discuss.flarum.org/d/5151-flagrow-bazaar-the-extension-marketplace) or install manually:
+
+```bash
+composer require flagrow/users-list
+```
+
+## Updating
+
+```bash
+composer update flagrow/users-list
+php flarum cache:clear
+```
+
+## Configuration
+
+Enable the extension.
+
+Visit the users tab on the admin area to view your users and send them emails.
+
+## Support our work
+
+We prefer to keep our work available to everyone.
+In order to do so we rely on voluntary contributions on [Patreon](https://www.patreon.com/flagrow).
+
+## Security
+
+If you discover a security vulnerability within Users list, please send an email to the Gravure team at [email protected]. All security vulnerabilities will be promptly addressed.
+
+Please include as many details as possible. You can use `php flarum info` to get the PHP, Flarum and extension versions installed.
+
+## Links
+
+- [Flarum Discuss post](https://discuss.flarum.org/d/6009-flagrow-users-list-review-and-mass-mail-users-of-your-forum)
+- [Source code on GitHub](https://github.com/flagrow/users-list)
+- [Changelog](https://github.com/flagrow/users-list/blob/master/CHANGELOG.md)
+- [Report an issue](https://github.com/flagrow/users-list/issues)
+- [Download via Packagist](https://packagist.org/packages/flagrow/users-list)
+
+An extension by [Flagrow](https://flagrow.io/), a project of [Gravure](https://gravure.io/).
diff --git a/composer.json b/composer.json
@@ -34,6 +34,9 @@
         "backgroundColor": "#f4f4f4",
         "color": "#5f4bb6"
       }
+    },
+    "flagrow": {
+      "discuss": "https://discuss.flarum.org/d/6009-flagrow-users-list-review-and-mass-mail-users-of-your-forum"
     }
   }
 }
diff --git a/readme.md b/readme.md