Skip to content

Commit

Permalink
docs(README): Add basic info, install instructions & simple example
Browse files Browse the repository at this point in the history
  • Loading branch information
ondrejsika committed Jan 3, 2023
1 parent 1fe564a commit 8d7f0b7
Showing 1 changed file with 56 additions and 1 deletion.
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 8d7f0b7

Please # to comment.