FEAT: impoved readme.md

davidibl · Mar 22, 2020 · 50cfda8 · 50cfda8
1 parent a1a9d0b
commit 50cfda8
Show file tree

Hide file tree

Showing 9 changed files with 51 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,52 @@
-# dmnmgr Client
+# dmnmgr-client
 
-This project contains a implementation of dmnjs with management functionality sorrounded.
-It's target is to provide a seemless integrated toolkit to model and manage bpmn processes.
+The DMN Manager is a toolkit incoperating the Camunda DMN implementation and providing
+tools to develop DMN based applications in cross functional teams.
+
+## General architecture
+
+![alt text](readme_assets/general_architecture.png "general architecture")
+
+- The client application is used to visually define business rules, simulate decision models and write tests. (This repository)
+- The server-side application provides web services to simulate decisions, run tests and validate DMN definitions. (https://github.com/davidibl/dmnmgr-server)
+- The test driver is a java library to run tests defined in the DMN Manager client during CI/CD processes automatically. (https://github.com/davidibl/dmnmgr-server)
+
+## Use
+
+To use this toolkit, you need to download a prebuild release or checkout this repository and build it for yourself.
+
+The webservice is a Spring Boot application which can be executed directly on the client mashine or on any server with java support.
+
+The webservice is only needed to simulate decisions or to tests DMN business rules.
+
+To use GIT support the standard GIT Client has to be installed on the mashine.
+
+### Configuration
+
+To configure the DMN Manager client open the settings page (Bearbeiten -> Einstellungen || STRG + K).
+
+On the settings page the base URL of the webservice and GIT credentials can be defined.
+
+## Contribution
+
+Feel free to contribute and extend the repositories with your ideas to improve the workflow around DMN based rules editing.
+
+## Functionality
+
+- Input Data Definition
+![alt text](readme_assets/datamodel.gif "input data definition")
+
+- Simulation
+![alt text](readme_assets/simulation.gif "simulation")
+
+- DMN Validation
+![alt text](readme_assets/validation.gif "validation")
+
+- Test definition and testing
+![alt text](readme_assets/testing_tool.gif "testing")
+
+- Basic Build-In GIT support
+![alt text](readme_assets/basic-git.gif "GIT support")
+
+- Editing tools
+![alt text](readme_assets/edit.gif "editing tools")
diff --git a/readme_assets/basic-git.gif b/readme_assets/basic-git.gif
diff --git a/readme_assets/datamodel.gif b/readme_assets/datamodel.gif
diff --git a/readme_assets/edit.gif b/readme_assets/edit.gif
diff --git a/readme_assets/general_architecture.png b/readme_assets/general_architecture.png
diff --git a/readme_assets/simulation.gif b/readme_assets/simulation.gif
diff --git a/readme_assets/testing_tool.gif b/readme_assets/testing_tool.gif
diff --git a/readme_assets/validation.gif b/readme_assets/validation.gif
diff --git a/readme_assets/workspace.gif b/readme_assets/workspace.gif