From 8b9c5c7de0704b87fd5f83b83a7995a659adc898 Mon Sep 17 00:00:00 2001
From: Holger Hagen <19706592+holgerhagen@users.noreply.github.com>
Date: Wed, 13 Dec 2017 13:47:07 +0100
Subject: [PATCH] TSK-108: readme and pom descriptions updated.
---
README.md | 40 +++++++++++++++++++++++++++---
lib/pom.xml | 2 ++
lib/readme.md | 4 +--
lib/taskana-cdi-example/pom.xml | 3 +++
lib/taskana-cdi/pom.xml | 4 +--
lib/taskana-core/pom.xml | 4 +--
lib/taskana-spring-example/pom.xml | 3 +++
lib/taskana-spring/pom.xml | 4 +--
8 files changed, 53 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index cdc53d6df..1b2a992a1 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,41 @@
+TASKANA - The open source task management library
+=================================================
+
[](https://travis-ci.org/Taskana/taskana)
+[](https://maven-badges.herokuapp.com/maven-central/pro.taskana/taskana-core)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
-# Hackathon
+TASKANA is a task management component open source library. It can be embedded into your application or be operated standalone if appropriate. Beside the basic task management functionalities, TASKANA adds workbaskets and classifications to control and monitor a large amount of tasks within a larger organization.
+
+* Web Site: https://taskana.pro/
+* Demo Environment: http://taskana-workplace.mybluemix.net
+* Getting Started: https://taskana.atlassian.net/wiki/spaces/TAS/pages/228655109/Getting+started
+* Issue Tracker: https://taskana.atlassian.net
+* Contribution Guildelines: https://taskana.atlassian.net/wiki/spaces/TAS/pages/274202625/Contribution+Guide
+* License: Apache License, Version 2.0 https://www.apache.org/licenses/LICENSE-2.0
+
+Components
+----------
+
+TASKANA splits up into five components:
+
+#### TASKANA core
+ * The Java library providing the task management functions
+
+#### TASKANA REST API
+ * REST API to allow remote access to the TASKANA system.
+
+#### TASKANA workplace
+ * Angular based web application to work on the tasks
+ * Sample tasklist application you can use if appropriate
+
+#### TASKANA admin
+ * Angular based web application to configure the system
+ * Supports workbaskets and classifications
+
+#### TASKANA monitor
+ * Angular based web application to monitor the status of the entire task pool
+ * Provides views and statistics about the conformance with defined services levels
+ * Shows the workload of your organization and the individual teams
+
-## Link to UI
-http://taskana-workplace.mybluemix.net
diff --git a/lib/pom.xml b/lib/pom.xml
index dcf00d79b..b8bd7894c 100644
--- a/lib/pom.xml
+++ b/lib/pom.xml
@@ -5,6 +5,8 @@
taskana-parent
0.0.3-SNAPSHOT
pom
+
+ This pom is parent to all taskana core modules and serves the common build.
1.8
diff --git a/lib/readme.md b/lib/readme.md
index 559bb0256..91bceb607 100644
--- a/lib/readme.md
+++ b/lib/readme.md
@@ -1,2 +1,2 @@
-TODO
-- Framework design checken
\ No newline at end of file
+The TASKANA Java library
+========================
diff --git a/lib/taskana-cdi-example/pom.xml b/lib/taskana-cdi-example/pom.xml
index 7c00bd362..da220c3df 100644
--- a/lib/taskana-cdi-example/pom.xml
+++ b/lib/taskana-cdi-example/pom.xml
@@ -32,4 +32,7 @@
0.0.3-SNAPSHOT
+ The Taskana Spring sample application.
+ http://taskana.pro
+ ${project.groupId}:${project.artifactId}
\ No newline at end of file
diff --git a/lib/taskana-cdi/pom.xml b/lib/taskana-cdi/pom.xml
index 7bb5517b3..4dcc03073 100644
--- a/lib/taskana-cdi/pom.xml
+++ b/lib/taskana-cdi/pom.xml
@@ -6,8 +6,7 @@
0.0.3-SNAPSHOT
${project.groupId}:${project.artifactId}
- TODO
- http://taskana-workplace.mybluemix.net
+ http://taskana.pro
@@ -239,4 +238,5 @@
+ The helper module to integrate taskana into CDI projects.
\ No newline at end of file
diff --git a/lib/taskana-core/pom.xml b/lib/taskana-core/pom.xml
index 523edf3ec..961d72ae3 100644
--- a/lib/taskana-core/pom.xml
+++ b/lib/taskana-core/pom.xml
@@ -6,8 +6,8 @@
0.0.3-SNAPSHOT
${project.groupId}:${project.artifactId}
- TODO
- http://taskana-workplace.mybluemix.net
+ The taskana library to include in your project.
+ http://taskana.pro
diff --git a/lib/taskana-spring-example/pom.xml b/lib/taskana-spring-example/pom.xml
index 12fb71fae..75ed9f6a5 100644
--- a/lib/taskana-spring-example/pom.xml
+++ b/lib/taskana-spring-example/pom.xml
@@ -59,4 +59,7 @@
+ ${project.groupId}:${project.artifactId}
+ http://taskana.pro
+ The Taskana Spring sample application.
diff --git a/lib/taskana-spring/pom.xml b/lib/taskana-spring/pom.xml
index a48a27bef..3c50bfd71 100644
--- a/lib/taskana-spring/pom.xml
+++ b/lib/taskana-spring/pom.xml
@@ -6,8 +6,7 @@
0.0.3-SNAPSHOT
${project.groupId}:${project.artifactId}
- TODO
- http://taskana-workplace.mybluemix.net
+ http://taskana.pro
@@ -193,4 +192,5 @@
test
+ The helper module to integrate taskana into Spring projects.
\ No newline at end of file