Merge pull request #36 from lstreckeisen/CMI-112-Update-READMEs

update plugin requirements & add poc note

Author: lstreckeisen

README.md

@@ -1,18 +1,17 @@
 <!-- Plugin description -->
 ![Context Mapper](https://raw.githubusercontent.com/wiki/ContextMapper/context-mapper-dsl/logo/cm-logo-github-small.png)
 # Context Mapper IntelliJ Plugin
-[ContextMapper](https://contextmapper.org/) is an open source tool providing a Domain-specific Language based on Domain-Driven Design (DDD) patterns for context mapping and service decomposition.
+
+> **_NOTE:_** This plugin is a proof of concept. It does not support all Context Mapper features yet.
+
+[Context Mapper](https://contextmapper.org/) is an open source tool providing a Domain-specific Language based on Domain-Driven Design (DDD) patterns for context mapping and service decomposition.
 
 ## System Requirements
-To use the ContextMapper IntelliJ plugin you need the following tools (besides IntelliJ and our extension) installed locally:
+To use the Context Mapper IntelliJ plugin you need the following tools (besides IntelliJ and our extension) installed locally:
 
 * [Oracle Java](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) or [OpenJDK](https://openjdk.java.net/) (JRE 11 or newer)
 * [Node.js](https://nodejs.org/en/download) (v22)
-* If you want to use our [Context Map generator](https://contextmapper.org/docs/context-map-generator/) you need to have [Graphviz](https://www.graphviz.org/) installed on your system.
-    * Ensure that the binaries are part of the _PATH_ environment variable and can be called from the terminal.
-    * Especially on Windows this is not the case after the installation of [Graphviz](https://www.graphviz.org/). The default installation path is
-      `C:\Program Files (x86)\GraphvizX.XX`, which means you have to add `C:\Program Files (x86)\GraphvizX.XX\bin` to your _PATH_ variable.
-* Maybe you want to install the [PlantUML extension](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml) for the generated PlantUML diagrams.
+* Maybe you want to install a [PlantUML extension](https://plugins.jetbrains.com/plugin/7017-plantuml-integration) for the generated PlantUML diagrams.
 * LSP4IJ IntelliJ plugin (will be installed automatically when installing our plugin)
 
 <!-- Plugin description end -->

build.gradle.kts

@@ -43,7 +43,7 @@ intellijPlatform {
 
     pluginConfiguration {
         id = "org.contextmapper.intellij-plugin"
-        name = "ContextMapper"
+        name = "Context Mapper"
         version = "0.3.1"
 
         productDescriptor {
@@ -55,7 +55,7 @@ intellijPlatform {
         }
 
         vendor {
-            name = "ContextMapper"
+            name = "Context Mapper"
             url = "https://contextmapper.org"
         }
 
@@ -100,7 +100,7 @@ tasks {
     }
 
     val npmInstall by registering(Exec::class) {
-        description = "Downloads the ContextMapper Language Server NPM package"
+        description = "Downloads the Context Mapper Language Server NPM package"
         group = LifecycleBasePlugin.BUILD_GROUP
         workingDir(layout.projectDirectory.dir("lsp"))
         val installCommand = "npm install"
@@ -113,7 +113,7 @@ tasks {
     }
 
     val copyLanguageServer by registering(Copy::class) {
-        description = "Extracts and copies the ContextMapper Language Server to the build directory"
+        description = "Extracts and copies the Context Mapper Language Server to the build directory"
         group = LifecycleBasePlugin.BUILD_GROUP
         dependsOn(npmInstall)
 

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

@@ -51,9 +51,9 @@
                 factoryClass="org.contextmapper.intellij.lsp4ij.server.ContextMapperDslServerFactory">
             <description>
                 <![CDATA[
-                <p>ContextMapper Language Server</p>
+                <p>Context Mapper Language Server</p>
                 <p>
-                    The ContextMapper Language Server provides support for the ContextMapper DSL in IntelliJ IDEA.
+                    The Context Mapper Language Server provides support for the ContextMapper DSL in IntelliJ IDEA.
                 </p>
                 ]]>
             </description>