Skip to content

Commit

Permalink
Update readme with goreportcard
Browse files Browse the repository at this point in the history
Also update some out of date information
  • Loading branch information
Rickard Dybeck committed Sep 22, 2016
1 parent 1a48691 commit c81f054
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
13 changes: 13 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Copyright 2016 Klarna AB

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Build Status][travis-image]](https://travis-ci.org/klarna/eremetic)
[![Coverage Status][coveralls-image]](https://coveralls.io/r/klarna/eremetic?branch=master)
[![Go Report][goreport-image]](https://goreportcard.com/report/github.com/klarna/eremetic)

## Purpose
Eremetic is a Mesos Framework to run one-shot tasks. The vision is to provide a
Expand Down Expand Up @@ -141,22 +142,29 @@ The file should contain the Principal to authenticate and the secret separated b
## Building

### Environment
Clone the repository into `$GOCODE/src/github.com/klarna/eremetic`.
Clone the repository into `$GOPATH/src/github.com/klarna/eremetic`.
This is needed because of internal package dependencies

### Install dependencies
First you need to install dependencies. Parts of the eremetic code is auto-generated (assets and templates for the HTML view are compiled). In order for go generate to work, `go-bindata` and `go-bindata-assetfs` needs to be manually installed.

go get github.com/jteeuwen/go-bindata/...
go get github.com/elazarl/go-bindata-assetfs/...
go generate
go get -t ./...

All other dependencies are vendored, so it is recommended to run eremetic with Go >= 1.6 or with GO15VENDOREXPERIMENT=1

### Creating the docker image
To build a docker image with eremetic, simply run

make docker

### Compiling
Run `make eremetic`

## Running tests
The default target of make builds and runs tests.
Tests can also be run by running `goconvey` in the project root.

## Running on mesos

Eremetic can itself by run on mesos using e.g marathon. An
Expand Down Expand Up @@ -202,3 +210,4 @@ Apache-2

[travis-image]: https://img.shields.io/travis/klarna/eremetic.svg?style=flat
[coveralls-image]: https://img.shields.io/coveralls/klarna/eremetic.svg?style=flat
[goreport-image]: https://goreportcard.com/badge/github.com/klarna/eremetic

0 comments on commit c81f054

Please sign in to comment.