Updating README.md

README.md

@@ -0,0 +1,21 @@
+# <img src="/preview/logo.png" title="logo" height="80" width="80" /> Dagger Plugin
+IntelliJ iDEA plugin to work with projects using <a href="https://dagger.dev/">Dagger 2</a> library
+
+<img src="/preview/screenshare.gif" alt="preview" title="preview"/>
+
+Install
+-----
+You can install the plugin from `Preferences` -> `Plugins` and search for the plugin.
+
+Features
+-----
+- View the dependency graph in tree format
+- Jump to source code from the graph
+- View parents and children of a node in the graph
+- Fully supported for project using both Java and Kotlin including Android
+
+Usage
+-----
+- Build your project, and the graph will be displayed in the <b>Dagger</b> tool window
+- Tap on <b>Refresh</b> in the Dagger tool window to refresh the graph
+- The plugin itself uses Dagger 2.27 and hence validations and graph will be calculated based on this version. For optimal usage, consider updating Dagger to the latest version

src/main/resources/META-INF/plugin.xml

@@ -16,6 +16,8 @@
         <ul>
             <li>Build your project and the graph will be displayed in the <b>Dagger</b> tool window</li>
             <li>Tap on <b>Refresh</b> in the Dagger tool window to refresh the graph</li>
+            <li>The plugin itself uses Dagger 2.27 and hence validations and graph will be calculated based on this version.
+            For optimal usage, consider updating Dagger to the latest version.</li>
         </ul>]]>
     </description>