composer package changes;

readme file updated

src/JsonRpc2/Controller.php → JsonRpc2/Controller.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace cranetm\JsonRpc2;
+namespace JsonRpc2;
 
 use Yii;
 use yii\base\InlineAction;

src/JsonRpc2/Exception.php → JsonRpc2/Exception.php

@@ -1,5 +1,5 @@
 <?php
-namespace cranetm\JsonRpc2;
+namespace JsonRpc2;
 
 class Exception extends \yii\base\Exception
 {

README.md

@@ -1,2 +1,50 @@
-yii2-json-rpc-2.0
+JSON RPC 2.0 for Yii2
 =================
+Easiest way to use in 4 steps:
+1) Install via composer
+   in ./composer.json add into 'require' section
+~~~php
+    "cranetm/yii2-json-rpc-2.0": "dev-master"
+~~~
+   and in console/terminal run
+~~~php
+composer update
+~~~
+
+2) Use namespace in your controller
+~~~php
+use \JsonRpc2\Controller;
+~~~
+   OR  change extends class to
+~~~php
+class ServicesController extends \JsonRpc2\Controller
+{
+    //BODY
+}
+~~~
+
+3) Create actions in Yii-style like
+~~~php
+public function actionUpdate($message)
+{
+	return ["message" => $message];
+}
+~~~
+
+4) Make json request to controller (used pretty urls without index.php)
+~~~php
+http://yoursite/services
+~~~
+   with data
+~~~php
+{
+    "jsonrpc": "2.0",
+	"id": 1,
+	"method": "update",
+	"params": ["hello world"]
+}
+~~~
+   and response will be
+~~~php
+{"jsonrpc":"2.0","id":1,"result":{"message":"hello world"}}
+~~~

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "tmudryi/yii2-json-rpc-2.0",
+    "name": "cranetm/yii2-json-rpc-2.0",
     "description": "JSON RPC 2.0 for Yii2",
     "license": "GNU",
     "authors": [
@@ -15,6 +15,6 @@
 		},
     "autoload": 
 		{
-			"psr-0": { "cranetm": "src/" }
+			"psr-0": { "JsonRpc2": "/" }
 		}
 }