Updated Reeadme.md

Rohit Kumar · Rohit Kumar · commit ab8f8210cd48 · 2022-03-04T23:27:06.000+05:30
diff --git a/README.md b/README.md
@@ -1 +1,77 @@
-# SexyDeployer
+
+# SexyDeployer - A simple and sexy continous deployment tool
+
+While working on one of project, i was in a sitatuion where i was in need up updating dev/prod server very frequently and that was frutrsated, i started looking at Jenkins, but it was taking a lot of time and you need to look at lot of youtube videos to get it working. SexyDeployer works on concept of webhooks and that webhook triggers all internal scripts to get your work done!
+
+
+
+
+## Installation
+
+```bash
+  $ git clone https://github.com/rohitcoder/SexyDeployer
+  $ cd SexyDeployer
+  $ bin/activaate
+  $ python3 -m ensurepip --default-pip
+  $ pip3 install -r requirements.txt
+  $ flask run
+```
+
+After running above commands you'll get a URL in output something like this.
+
+![Preview](https://i.imgur.com/8rA5RdN.png)
+
+Copy this URL and visit, https://github.com/<Username>/<REPO_NAME>/settings/hooks/new
+
+paste above URL, and in section "Which events would you like to trigger this webhook?
+", select "Just the push event."
+
+Now click on Add webhook.
+
+Now configure, ``config.yaml`` file
+
+```YAML
+PROJECT_PATH: This is path of project, where you want to host your source code of application.
+
+SLACK_WEBHOOK`: This is SLACK_WEBOOK url for logging purpose
+```
+
+#### Want to do something more Precisely?
+Use `scripts/build.sh` and `scripts/deploy.sh` to add your custom exec commands
+## Features
+
+- Connect webhook with your github Repo
+- Works with multiple branches simultaneously
+- Supports ``build.sh`` and ``deploy.sh`` scripts which helps you running custom commands.
+- Sends status reports in a slack workspace.
+
+
+## FAQ
+
+#### Is this the best tool available, should i used it?
+
+You can look into Jenkins, this tool is for those who just want to deploy continously without doing much efforts. This tool is still in early phase of development. You should first test it then implement on prod servers.
+
+#### Is this Secure?
+
+Well, you have full access to source code, you can also do a code review. We're just using webhook from git and triggering some scripts internally, if you find any security issue please create an issue report.
+
+
+## Authors
+
+- [@rohitcoder - Rohit Kumar](https://github.com/rohitcoder)
+
+
+## Contributing
+
+Contributions are always welcome!
+
+See `contributing.md` for ways to get started.
+
+Please adhere to this project's `code of conduct`.
+
+
+## Tech Stack
+
+Python Flask Server, YAML, Linux
+
diff --git a/bin/flask b/bin/flask
@@ -1,4 +1,4 @@
-#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3.9
+#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys
diff --git a/bin/normalizer b/bin/normalizer
@@ -1,4 +1,4 @@
-#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3.9
+#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys
diff --git a/bin/pip b/bin/pip
@@ -1,4 +1,4 @@
-#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3.9
+#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys
diff --git a/bin/pip3 b/bin/pip3
@@ -1,4 +1,4 @@
-#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3.9
+#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys
diff --git a/bin/pip3.9 b/bin/pip3.9
@@ -1,4 +1,4 @@
-#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3.9
+#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3
 # -*- coding: utf-8 -*-
 import re
 import sys

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3.9`
	`1`	`+#!/Users/rohitcoder/Desktop/Projects/SexyDeployer/bin/python3`
`2`	`2`	`# -- coding: utf-8 --`
`3`	`3`	`import re`
`4`	`4`	`import sys`