From ebccec6f4eebe6ec48bd68bb01fd39c5b6f5983e Mon Sep 17 00:00:00 2001
From: David Andlinger <david.andlinger@instant-it.at>
Date: Fri, 2 Jun 2023 14:03:47 +0200
Subject: [PATCH] added readme file

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d212139
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# MongoDB
+![Release](https://github.com/instant-solutions/mongo/actions/workflows/build.yml/badge.svg)
+
+A Docker image which is based on the [Mongo image](https://hub.docker.com/_/mongo) and includes the [`mongo-healthcheck` binary](https://github.com/instant-solutions/mongo-healthcheck/).
+
+## Quick Start
+
+Open a terminal and run the following command:
+
+#### GitHub Container Registry
+
+``` 
+docker run -d -p 27017:27017 ghcr.io/instant-solutions/mongo
+```
+
+#### Docker Hub
+
+``` 
+docker run -d -p 27017:27017 i15s/mongo
+```
+
+For more information, please also refer to the base image documentation: https://hub.docker.com/_/mongo
+
+## Contribution
+
+Feel free to fork the project and send us a pull-request! :sunglasses:
+
+Or consider sponsoring us, so we can continue to work on this project: [GitHub Sponsors](https://github.com/sponsors/instant-solutions) :star_struck:
+
+## Author
+
+Made with :heart: in Austria by [instant:solutions OG](https://instant-it.at)
\ No newline at end of file