diff --git a/README.md b/README.md index a1ad7db..2c65077 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ -# dockship -A powerful self-hosted Deployment Platform +
+ Key Features • + Installation • + License +
+ + + +## 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) · +> GitHub [@orus-dev](https://github.com/orus-dev) + +Huge thank you to [@amitmerchant1990](https://github.com/amitmerchant1990) for making this readme template diff --git a/github/dockship-bg.svg b/github/dockship-bg.svg new file mode 100644 index 0000000..1fe543f --- /dev/null +++ b/github/dockship-bg.svg @@ -0,0 +1,14 @@ + diff --git a/github/dockship.svg b/github/dockship.svg new file mode 100644 index 0000000..5433c11 --- /dev/null +++ b/github/dockship.svg @@ -0,0 +1,13 @@ + diff --git a/installer.sh b/installer.sh new file mode 100644 index 0000000..e69de29