Merge pull request #405 from takahirom/takahirom/add-idea-plugin-sect…

…ion/2024-06-12 Add README section of idea plugin
takahirom · Jun 12, 2024 · f969bfe · f969bfe
2 parents c3faf4f + 76a2784
commit f969bfe
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -944,6 +944,19 @@ If you are having trouble debugging your test, try Dump mode as follows.
 
 ![image](https://user-images.githubusercontent.com/1386930/226364158-a07a0fb0-d8e7-46b7-a495-8dd217faaadb.png)
 
+</div>
+<div name="topic_idea_plugin">
+
+<!-- Generated by docs/topics/idea_plugin.md. Do not edit this file. -->
+# Roborazzi IntelliJ IDEA and Android Studio Plugin
+
+https://plugins.jetbrains.com/plugin/24561-roborazzi
+
+Demo of Roborazzi IntelliJ IDEA and Android Studio Plugin.
+
+https://github.com/takahirom/roborazzi/assets/1386930/bd3e8106-1971-4ec4-b764-3f1831999228
+
+The Roborazzi plugin enhances your development workflow by automatically displaying screenshots related to Roborazzi's screenshot tests within IntelliJ IDEA. Easily view and verify visual outputs directly in your IDE, streamlining your testing and development process.
 </div>
 <div name="topic_compose_multiplatform">
 
@@ -1023,7 +1036,7 @@ Then, you can run the Gradle tasks for iOS Support, just like you do for Android
 ...
 ```
 
-The currently implemented features are as follows:
+The currently implemented features for iOS support are as follows:
 
 | Feature | status |
 |---|---|

diff --git a/README.template.md b/README.template.md
@@ -7,6 +7,8 @@
 </div>
 <div name="topic_how_to_use">
 </div>
+<div name="topic_idea_plugin">
+</div>
 <div name="topic_compose_multiplatform">
 </div>
 <div name="topic_gradle_properties_options">

diff --git a/docs/roborazzi-docs.tree b/docs/roborazzi-docs.tree
@@ -10,6 +10,7 @@
     <toc-element topic="try_it_out.md"/>
     <toc-element topic="build_setup.md"/>
     <toc-element topic="how_to_use.md"/>
+    <toc-element topic="idea_plugin.md"/>
     <toc-element topic="compose_multiplatform.md"/>
     <toc-element topic="gradle_properties_options.md"/>
     <toc-element topic="faq.md"/>

diff --git a/docs/topics/compose_multiplatform.md b/docs/topics/compose_multiplatform.md
@@ -73,7 +73,7 @@ Then, you can run the Gradle tasks for iOS Support, just like you do for Android
 ...
 ```
 
-The currently implemented features are as follows:
+The currently implemented features for iOS support are as follows:
 
 | Feature | status |
 |---|---|

diff --git a/docs/topics/idea_plugin.md b/docs/topics/idea_plugin.md
@@ -0,0 +1,9 @@
+# Roborazzi IntelliJ IDEA and Android Studio Plugin
+
+https://plugins.jetbrains.com/plugin/24561-roborazzi
+
+Demo of Roborazzi IntelliJ IDEA and Android Studio Plugin.
+
+https://github.com/takahirom/roborazzi/assets/1386930/bd3e8106-1971-4ec4-b764-3f1831999228
+
+The Roborazzi plugin enhances your development workflow by automatically displaying screenshots related to Roborazzi's screenshot tests within IntelliJ IDEA. Easily view and verify visual outputs directly in your IDE, streamlining your testing and development process.