add documents for first release

Author: lotabout

LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2017 Jinzhou Zhang
+
+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
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+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.

README.md

@@ -0,0 +1,43 @@
+# CodeGenerator
+An idea-plugin for code generation, support template customization.
+
+// TODO: add demo
+
+As we know, Intellij had provided useful code generators such as constructors,
+getter/setters, equals, hashCode, overrides and delegates, etc. And Intellij
+allows us to apply customized velocity templates for each generator. But we
+cannot add our own generators.
+
+Code Generator is here to help. Two types of generation are supported here
+- Members(fields/method) based templates, such as serializers, equals, etc.
+- Class based template, such as transformers, converters, etc. Normally new classes are created.
+
+# Installation
+
+1. Search `CodeGenerator` in Idea plugins
+2. Download zip from from [Releases](https://github.com/lotabout/CodeGenerator/releases)
+
+To install a plugin from the disk in idea:
+
+1. Open the `Settings/Preferences` dialog box and select `Plugins` on the left pane.
+2. On the right pane of the dialog, click the `Install plugin from disk` button.
+3. Select the location of the zip file, click OK to continue.
+4. Click `Apply` button of the Settings/Preferences dialog.
+5. Restart IntelliJ IDEA to activate.
+
+# Usage
+
+1. Go to the `Settings/Preferences > Other Settings > CodeGenerator` to
+   create a new generator/template.
+2. Right click on your java file, Select `Generate > CodeGenerator > [name of
+   your generator]` to run the generator.
+
+According to the settings of your generator, there might be dialogs show up
+asking to select members or classes that's required by your generator.
+
+# Thanks to
+- [CodeMaker](https://raw.githubusercontent.com/x-hansong/CodeMaker): where
+    the idea and part of code comes from.
+- [generate-tostring](https://github.com/JetBrains/intellij-community/tree/master/plugins/generate-tostring):
+  Offical toString generator. Part of the code comes from it.
+

resources/META-INF/plugin.xml

@@ -1,23 +1,27 @@
 <idea-plugin>
   <id>me.lotabout.codegenerator</id>
   <name>CodeGenerator</name>
-  <version>0.2</version>
-  <vendor email="lotabout@gmail.com" url="https://lotabout.me">LotAbout</vendor>
+  <version>1.0</version>
+  <vendor email="lotabout@gmail.com" url="https://lotabout.me">Personal</vendor>
 
   <description><![CDATA[
-      Code Generator enables us to create customized velocity templates for code generation.
-      Intellij had already support common generations like constructors, getters/setters, toString, etc.
-      These templates however are limited, for example toString will allow us to generate `toString` method only.
-      Code Generator want to generalize the ability to utilize velocity templates so that you can create whatever
-      template you need.
-
-      Currently only Java files are supported.
-      <em>most HTML tags may be used</em>
+  <p>This plugin allows user to create customized velocity templates like <code>toString</code> or <code>builder</code></p>
+  <p>As we know, Intellij had provided useful code generators such as constructors, getter/setters, equals, hashCode,
+   overrides and delegates, etc. And Intellij allows us to apply customized velocity templates for each generator.
+   But we cannot add our own generators.</p>
+  <p>Code Generator is here to help. Two types of generation are supported here</p>
+  <ul>
+    <li>Members(fields/method) based templates, such as serializers, equals, etc.</li>
+    <li>Class based template, such as transformers, converters, etc. Normally new classes are created.</li>
+  </ul>
+  <p>I've always hoped Intellij would support this by default, but for now we have an working alternative.</p>
+  <p>See <a href="https://github.com/lotabout/CodeGenerator/blob/master/README.md">README</a> for more</p>
     ]]></description>
 
   <change-notes><![CDATA[
-      Add change notes here.<br>
-      <em>most HTML tags may be used</em>
+  <ul>
+  <li>version 1.0 <p>First release</p></li>
+  </ul>
     ]]>
   </change-notes>