Add README to plugin definition and README.md

Author: cedricziel

META-INF/plugin.xml

@@ -1,12 +1,40 @@
 <idea-plugin version="2">
   <id>com.cedricziel.idea.typo3</id>
   <name>TYPO3</name>
-  <version>0.1</version>
+  <version>0.1.0</version>
   <vendor email="cedric@cedric-ziel.com" url="https://www.cedric-ziel.com">Cedric Ziel</vendor>
 
   <description><![CDATA[
-      TYPO3 CMS Plugin for IntelliJ IDEA products.
-      <strong>EXPERIMENTAL</strong>
+<h1>TYPO3 CMS Plugin</h1>
+
+<strong>beta quality</strong>
+
+<h2>Features:</h2>
+
+<h3>Service Locator & Extbase Dependency Injection Container</h3>
+
+<p>
+  The plugin provides you with greater code stability, since the return types of
+  instance creations are inferred, giving you stable auto-completion and insight
+  into the written code.
+</p>
+
+<ul>
+  <li>infer return type of GeneralUtility::makeInstance() calls without meta file</li>
+  <li>infer return type of ObjectManager::get() calls without meta file</li>
+</ul>
+
+<h2>Credits</h2>
+<p>Thank you to <a href="https://github.com/Haehnchen">Daniel Espendiller</a> and <a href="https://github.com/adrienbrault">Adrien Brault</a>
+for providing their <a href="https://github.com/Haehnchen/idea-php-symfony2-plugin">Symfony2 Plugin</a> in the first place.
+It is a great inspiration for possible solutions and parts of the code.</p>
+
+
+<h2><a href="https://github.com/cedricziel/idea-php-typo3-plugin/graphs/contributors">Contributors</a></h2>
+<ul>
+    <li><a href="https://github.com/cedricziel">Cedric Ziel</a></li>
+    <li><a href="https://github.com/cedricziel/idea-php-typo3-plugin/graphs/contributors">GitHub Contributors</a></li>
+</ul>
     ]]></description>
 
   <change-notes><![CDATA[
@@ -17,11 +45,6 @@
   <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/build_number_ranges.html for description -->
   <idea-version since-build="145.0"/>
 
-  <!-- please see http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html
-       on how to target different products -->
-  <!-- uncomment to enable plugin in all products
-  <depends>com.intellij.modules.lang</depends>
-  -->
   <depends>com.jetbrains.php</depends>
 
   <extensions defaultExtensionNs="com.intellij">
@@ -38,4 +61,4 @@
     <!-- Add your actions here -->
   </actions>
 
-</idea-plugin>
+</idea-plugin>

README.md

@@ -1,10 +1,30 @@
-# EXPERIMENTAL TYPO3 CMS Plugin for Jetbrains IDEA based products
+# TYPO3 CMS Plugin for IntelliJ IDEA / PhpStorm
+
+## Installation
+
+On PhpStorm or IntelliJ:
+
+* open "File" -> "Settings"
+* select "Plugins"
+* select "Browse Plugins"
+* search "TYPO3"
+* choose the plugin in the left pane, click the install button in 
+  the right pane
+* hit apply, close the window
+* restart your IDE
+* profit!
 
 ## Features
 
 * TypeProvider for `GeneralUtility::makeInstance`
 * TypeProvider for `ObjectManager::get`
 
+## Credits
+
+Thank you to <a href="https://github.com/Haehnchen">Daniel Espendiller</a> and <a href="https://github.com/adrienbrault">Adrien Brault</a>
+for providing their <a href="https://github.com/Haehnchen/idea-php-symfony2-plugin">Symfony2 Plugin</a> in the first place.
+It is a great inspiration for possible solutions and parts of the code.
+
 # License
 
 MIT