Readme

Author: Bizley

README.md

@@ -1,8 +1,37 @@
 # Yii 2 Podium API
 
 ![Build](https://github.com/yii-podium/yii2-api/workflows/Tests/badge.svg)
+![Latest Stable Version](https://img.shields.io/packagist/v/yii-podium/yii2-api.svg)
+[![Total Downloads](https://img.shields.io/packagist/dt/yii-podium/yii2-api.svg)](https://packagist.org/packages/yii-podium/yii2-api)
+![License](https://img.shields.io/packagist/l/yii-podium/yii2-api.svg)
 
-**[Work In Progress]**
+Yii 2 Forum Engine Module API
 
-TODO:
-- Add method's comments in interfaces.
+## Installation
+
+Run console command
+
+```
+composer require yii-podium/yii2-api
+```
+
+Or add the package to your `composer.json` file:
+
+```
+{
+    "require": {
+        "yii-podium/yii2-api": "^0.1"
+    }
+}
+```
+
+then run `composer update`.
+
+## Configuration And Usage
+
+Please refer to the [Documentation](https://github.com/yii-podium/yii2-api/blob/master/docs/).
+
+## Podium Packages
+
+- Yii 2 Podium Web Client (WIP)
+- Yii 2 Podium Rest Client (WIP)