From 8d7f0b728400ef294e9c1d9b37f4a306e019908a Mon Sep 17 00:00:00 2001
From: Ondrej Sika <ondrej@ondrejsika.com>
Date: Tue, 3 Jan 2023 19:28:45 +0100
Subject: [PATCH] docs(README): Add basic info, install instructions & simple
 example

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 56 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e04161a..b9dab07 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,56 @@
-# gobble
+# Gobble: Like Ansible but in Go
+
+## What is Gobble?
+
+Gobble is a config management tool like Ansible but written in Go. It is designed to be simple and easy to use.
+
+## Installation
+
+Mac
+
+```
+brew install sikalabs/tap/gobble
+```
+
+Linux
+
+```
+curl -fsSL https://raw.githubusercontent.com/sikalabs/gobble/master/install.sh | sudo sh
+```
+
+Using [slu](https://github.com/sikalabs/slu)
+
+```
+slu install-bin gobble
+```
+
+## Example Usage
+
+Create `gobblefile.yml`
+
+```yaml
+meta:
+  schema_version: 2
+hosts:
+  all:
+    - ssh_target: root@gobble-example.sikademo.com
+      vars:
+        msg: Gobble Gobble!
+plays:
+  - name: Nginx Example
+    hosts: [all]
+    tasks:
+      - name: Install Nginx
+        apt_install:
+          name: nginx
+      - name: Create index.html
+        templete:
+          path: /var/www/html/index.html
+          template: <h1>{{.Vars.msg}}</h1>{{ printf "\n" }}
+```
+
+Run
+
+```
+gobble run
+```