Init

2025-12-25 22:14:55 +01:00
parent 5fd142fc54
commit fb44d9004a
4 changed files with 77 additions and 2 deletions
@@ -1,2 +1,50 @@
-# dockship
-A powerful self-hosted Deployment Platform
+<h1 align="center">
+  <br>
+  <a href="https://orus-dev.netlify.app/projects"><img src="github/dockship.svg" alt="DockShip" width="350"></a>
+  <br>
+  DockShip
+  <br>
+</h1>
+
+<h4 align="center">A powerful self-hosted Deployment Platform</h4>
+
+<p align="center">
+  <a href="#key-features">Key Features</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#license">License</a>
+</p>
+
+![screenshot (TODO)](/github/screensot.png)
+
+## Key Features
+
+- Easy deployment
+
+## Installation
+
+#### Dependencies
+
+- [Git](https://git-scm.com)
+- [Docker](https://www.docker.com)
+- [Node.js](https://nodejs.org/en/download/)
+
+Run this on bash
+
+```bash
+wget -qO- https://raw.githubusercontent.com/orus-dev/dockship/refs/heads/master/installer.sh | bash
+```
+
+Or with curl
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/orus-dev/dockship/refs/heads/master/installer.sh | bash
+```
+
+## License
+
+MIT
+
+> Website [orus-dev.app](https://orus-dev.netlify.app) &nbsp;&middot;&nbsp;
+> GitHub [@orus-dev](https://github.com/orus-dev)
+
+Huge thank you to [@amitmerchant1990](https://github.com/amitmerchant1990) for making this readme template