Merge pull request #4 from DeepCodeAI/dev

Dev

Author: Arvi3d

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [2.0.0] - 2020-06-20
+- Common logic moved to java-client from jetbrains-plugin
+
+## [1.0.0] - 2020-06-20
+- Final major release for 1.x version branch before switching to 2.x
+
 ## [0.0.13] - 2020-05-27
 - `Check Bundle` API function added
 

README.md

@@ -1,7 +1,13 @@
 # java-client
 Deepcode Public API package in Java
 
-For APIs look for `DeepCodeRestApi` public methods. For descriptions look [Rest APIs and CLI](https://deepcode.freshdesk.com/support/solutions/folders/60000321393)
+For low level APIs look for `DeepCodeRestApi` public methods. For descriptions look [Rest APIs and CLI](https://deepcode.freshdesk.com/support/solutions/folders/60000321393)
+
+For high-level APIs look inside `ai.deepcode.javaclient.core` package.
+Here common logic for any Java made IDE presented as `abstract` classes that need to be instantiated and finalised with platform specific code.
+See [jetbrains-plugin](https://github.com/DeepCodeAI/jetbrains-plugin) for usage example.
+
+Architect overview of common logic: Inversion of Control (Dependency Injection pattern) is implemented through constructor parameters injection. 
 
 ## Build the jar
 

build.gradle

@@ -18,7 +18,7 @@ repositories {
     jcenter()
 }
 
-version '0.0.13'
+version '2.0.0'
 sourceCompatibility = 1.8
 
 dependencies {