Skip to content
This repository was archived by the owner on Feb 27, 2018. It is now read-only.

Commit 60631ce

Browse files
committed
update readme with setup instructions
1 parent 94ee4fd commit 60631ce

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

README.md

+15-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
Check out http://shopify.github.com/dashing for more information.
1+
# Panter Dashboard
22

3-
# Setup
3+
![Screenshot](screenshot.png)
44

5-
You need ruby set up on your machine. Probably using `rbenv`.
5+
Built with [Dashing](https://shopify.github.io/dashing/).
66

7-
Get libraries installed:
7+
## Components used
88

9-
bundle
9+
* Redis
10+
* Panter Controllr
11+
* Github
12+
* Gitlab
1013

11-
Configure access tokens by copying `.env.example` to `.env` and fill in the
12-
needed values.
14+
## Setup
1315

14-
You're now ready to start the dashboard:
15-
16-
dashing start
16+
* Install ruby (`rbenv` recommended)
17+
* Install redis
18+
* `cp .env.example .env` and fill in some values (esp. the access tokens)
19+
* `cp config/salaries.yml.sample config/salaries.yml` and fill in some values
20+
* `bundle`
21+
* `dashing s`

screenshot.png

83.3 KB
Loading

0 commit comments

Comments
 (0)