Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SergeyTsalkov authored Dec 17, 2018
1 parent 7e57a5e commit 061ad08
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,25 @@ I've been personally relying on brooce with great results! If you try it out, I
Brooce uses redis as its database. Redis can be accessed from any programming language, but how to do it for each one is beyond the scope of this documentation. All of our examples will use the redis-cli shell commands, and it's up to you to substitute the equavalents in your language of choice! If you're a programmer and you haven't learned redis yet, you owe it to yourself to do so!

# Quick Start
Just a few commands will download brooce and get it running:

## Option 1: Download our binaries!
This is simplest, and will get you running immediately.
```shell
sudo apt-get install redis-server
wget https://github.com/SergeyTsalkov/brooce/releases/download/v1.3.0/brooce-linux -O brooce
chmod 755 brooce
./brooce
```

*Note: For the purpose of this tutorial, you're just downloading our binaries. If you prefer to build from source, the instructions are at the end of this file.*
## Option 2: Build from source!
You must have Go 1.11 or newer installed.
```shell
sudo apt-get install redis-server
git clone https://github.com/SergeyTsalkov/brooce.git
cd brooce
go build
./brooce
```

You'll see the output shown below:
```
Expand Down Expand Up @@ -232,13 +242,3 @@ redis-cli HSET "brooce:cron:jobs" "daily-biller" "0 0 * * * queue:common ~/bin/b
redis-cli HSET "brooce:cron:jobs" "hourly-log-rotater" "0 * * * * queue:common ~/bin/rotate-logs.sh"
redis-cli HSET "brooce:cron:jobs" "twice-daily-error-checker" "0 */12 * * * queue:common ~/bin/check-for-errors.sh"
```

# Build From Source
We now rely on go modules, so building from source is simple:
```shell
sudo apt-get install redis-server
git clone https://github.com/SergeyTsalkov/brooce.git
cd brooce
go build
./brooce
```

0 comments on commit 061ad08

Please sign in to comment.