Update readme

Neenad Ingole
1 parent 7f668225
Showing 1 changed file with 37 additions and 2 deletions Show diff stats
README.md
-Docker Compose Images for different stacks
+Awesome Docker Compose
 ---
-## How to run:
+## What is this?
+
+This is a collection of docker compose stacks for daily software development work.
+It becomes handy when you want to run a stack of docker containers and you don't want to write a docker compose file for
+it.
+There are many docker compose files available on the internet but they are not well maintained and they are not up to
+date.
+This repository is a collection of docker compose files that are well maintained and up to date.
+
+## What is docker compose?
+
+Docker compose is a tool for defining and running multi-container Docker applications.
+
+## How to use?
+
+Clone this repository and run the docker compose file inside the directory.
+
+Example:
+
 Inside directory e.g. `sonarqube`
 ```
@@ -10,6 +28,23 @@ sonarqube $&gt; docker-compose up
 use `-d` to start compose in detach mode
+## Stacks
+
+| Stack                   | Standalone | Cluster |
+|-------------------------|------------|---------|
+| Apache Kafka            | ✅          | ✅       |
+| Debezium - Postgres     | ✅          |         |
+| Debezium - MySQL        | ✅          |         |
+| Jaeger                  | ✅          |         |
+| Postgres                | ✅          | ✅       |
+| Prometheus + Grafana    | ✅          |         |
+| Prometheus Push Gateway | ✅          |         |
+| ScyllaDB                | ✅          | ✅       |
+| SonarQube               | ✅          |         |
+| KSQLDB      [WIP]       |           |         |
+| MySQL      [WIP]        |           |         |
+| MongoDB      [WIP]      |           |         |
+
 ## How to contribute
 Raise a pull request if you are using docker compose stack and automated it for your daily software development work.
1	-Docker Compose Images for different stacks	1	+Awesome Docker Compose
2	---	2	---
3		3
4	-## How to run:	4	+## What is this?
		5	+
		6	+This is a collection of docker compose stacks for daily software development work.
		7	+It becomes handy when you want to run a stack of docker containers and you don't want to write a docker compose file for
		8	+it.
		9	+There are many docker compose files available on the internet but they are not well maintained and they are not up to
		10	+date.
		11	+This repository is a collection of docker compose files that are well maintained and up to date.
		12	+
		13	+## What is docker compose?
		14	+
		15	+Docker compose is a tool for defining and running multi-container Docker applications.
		16	+
		17	+## How to use?
		18	+
		19	+Clone this repository and run the docker compose file inside the directory.
		20	+
		21	+Example:
		22	+
5	Inside directory e.g. `sonarqube`	23	Inside directory e.g. `sonarqube`
6		24
7	```	25	```
	@@ -10,6 +28,23 @@ sonarqube $> docker-compose up		@@ -10,6 +28,23 @@ sonarqube $> docker-compose up
10		28
11	use `-d` to start compose in detach mode	29	use `-d` to start compose in detach mode
12		30
		31	+## Stacks
		32	+
		33	+\| Stack \| Standalone \| Cluster \|
		34	+\|-------------------------\|------------\|---------\|
		35	+\| Apache Kafka \| ✅ \| ✅ \|
		36	+\| Debezium - Postgres \| ✅ \| \|
		37	+\| Debezium - MySQL \| ✅ \| \|
		38	+\| Jaeger \| ✅ \| \|
		39	+\| Postgres \| ✅ \| ✅ \|
		40	+\| Prometheus + Grafana \| ✅ \| \|
		41	+\| Prometheus Push Gateway \| ✅ \| \|
		42	+\| ScyllaDB \| ✅ \| ✅ \|
		43	+\| SonarQube \| ✅ \| \|
		44	+\| KSQLDB [WIP] \| \| \|
		45	+\| MySQL [WIP] \| \| \|
		46	+\| MongoDB [WIP] \| \| \|
		47	+
13	## How to contribute	48	## How to contribute
14		49
15	Raise a pull request if you are using docker compose stack and automated it for your daily software development work.	50	Raise a pull request if you are using docker compose stack and automated it for your daily software development work.