From 70a777db3a82470941dfe0ccbf6a6018485af726 Mon Sep 17 00:00:00 2001
From: Urko <urko@fungimail.com>
Date: Sun, 26 Feb 2023 10:58:32 +0100
Subject: [PATCH] feat: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f6df21
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# git-webhook-ci
+Tool to automatize your deploy based on file write changes
+
+## Context
+As a security risk that could be allow a webhook listener on a VPS for your git repository, I've decided
+to create this package which is a listener to file changes on write. This will trigger a bash script which
+you shold place on your server to run desired tasks. In my case I've done this to run a bash deploy command like
+ - git pull
+ - build
+ - move build to desired dir
+ - restart services like nginx or whatever
+
+## Installation
+### Requirements
+- [Go version > 1.19](https://go.dev/dl/)
+- [GNU Make 4.3](https://www.gnu.org/software/make/)
+- [goreportcard-cli](https://github.com/gojp/goreportcard)
+- [golangci-lint](https://golangci-lint.run/)