Merge pull request #1 from numa08/readme

Readme

LICENSE

@@ -1,13 +1,21 @@
-   Copyright 2014 Hidetake Iwata
+The MIT License (MIT)
 
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
+Copyright (c) 2015 Takaya Funabiki
 
-       http://www.apache.org/licenses/LICENSE-2.0
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

README.md

@@ -1,26 +1,64 @@
 Gradle Release Note Generator Plugin
 ======================
 
-Generate symple release notes from git log for gradle project.
+Generate simple release notes from git log for gradle project.
 
 Tasks
 --------
 
  - generateReleaseNote
- - generateReleaseMarkdown
+
+Installation
+----------
+
+```groovy
+buildscript {
+    respositories {
+        maven { url "https://dl.bintray.com/numa08/maven" }
+    }
+    dependencies {
+        classpath 'net.numa08:genrelease:$version'
+    }
+}
+apply plugin: 'net.numa08.genrelease'
+```
 
 Configurations
 --------------
 
- - commitFrom(String)
-     - from commit
- - commitTo(String)
- 	  - to commit
+`releaseNote` closure to your `build.gradle` file. This closure has 3 properties.
+
+ - version - Your application version.
+ - source - Release note will be generated by this source messages.
+ - output(optional) - Release note will be written this file.If empty then output stdout. 
 
 Sample
 ------
 
-When `git log` are
+```groovy
+releaseNote {
+ version "1.0"
+ source "git log".execute()
+ output file("Release.txt")
+}
+```
+
+Spec
+-----
+
+Release note format is Markdown. This plugin parse spec
+
+  [scope]/[subject]: [description]
+
+ - scope
+   - fix - covert to 不具合修正
+   - feat - convert to 新機能
+ - subject - Name for fix or feature.
+ - description - description for subject.
+
+## 
+
+When source is
 
 ```
 fix/なんとか機能: どうしようもないクラッシュ問題を対応しました。