Merge pull request #1 from umm-projects/write_readme

README

README.md

@@ -1,26 +1,35 @@
-# What
+# Command Runner
 
-* 
+* cli コマンドを実行
 
-# Why
+## Requirement
 
-* 
+* Unity 2017
 
-# Requirement
-
-* 
-
-# Install
+## Install
 
 ```shell
-$ npm install github:umm-projects/command_runner
+yarn add github:umm-projects/command_runner
 ```
 
-# Usage
+## Usage
+
+```csharp
+using UnityModule.Command;
+using UnityEngine;
+
+public class Sample {
+
+    public void Run() {
+        Debug.Log(Runner<string>.Run("git", "status"));
+    }
+
+}
+```
 
-* 
+* `Runner` クラスの型引数に `UniRx.IObservable<T>` を指定すると [UniRx](https://github.com/umm-projects/unirx) による非同期処理を行います
 
-# License
+## License
 
 Copyright (c) 2018 Tetsuya Mori