From 2087abc4223c8be94d0386ee2d9915ddc5e7de7f Mon Sep 17 00:00:00 2001 From: Tushar <30565750+tushar5526@users.noreply.github.com> Date: Mon, 29 Jan 2024 21:51:39 +0530 Subject: [PATCH] Update README.md (#26) * Update README.md * Update readme * Update Readme --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 24ff929..3094e2c 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,19 @@ [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) ![contributions welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square) ![GitHub contributors](https://img.shields.io/github/contributors-anon/tushar5526/sarthi) [![codecov](https://codecov.io/gh/tushar5526/sarthi/graph/badge.svg?token=85RAG9BYA4)](https://codecov.io/gh/tushar5526/sarthi)![tests](https://github.com/tushar5526/sarthi/actions/workflows/test.yml/badge.svg)![lints](https://github.com/tushar5526/sarthi/actions/workflows/lint.yml/badge.svg) +### Vercel for Backend! Easily setup preview environments with just Docker 🐳 + Self-host Ephemeral (Preview) Environments with ease and forget about server management. -Sarthi uses other open-source projects to export logs, enable monitoring, manage secrets and create preview environments. +Sarthi uses other open-source projects to export logs, enable monitoring, manage secrets and create preview environments. Let devs focus on building stuff in isolated environments rather than bashing heads together to manage conflicts. -It is meant to be used along with [sarthi-deploy](https://github.com/tushar5526/sarthi-deploy) GitHub Action for setting up preview environments in your project. Every time there is a new branch or a PR created, Sarthi GHA will create a preview environment for that. It also takes care of cleaning up preview environments when respective branches or PRs are merged. +It is meant to be used along with [sarthi-deploy](https://github.com/tushar5526/sarthi-deploy) GitHub Action for setting up preview environments in your project. Every time there is a new branch or a PR created, Sarthi GHA will create a preview environment for that. It also takes care of deleting preview environments when respective branches or PRs are merged. ## Pre-requisites 🛠️ 1. Dockerized projects with a `docker-compose`. - It is **MANDATORY** to have a `docker-compose` file at the root of the project's folder. 2. A public Linux machine (preferred Ubuntu 20+ LTS versions) and user with root access. -3. A wildcard subdomain pointing to the above machine (\*.sarthi.your-domain.io) +3. A wildcard subdomain pointing to the above machine `(\*.sarthi.your-domain.io)` ## General Flow