Skip to content

Commit

Permalink
Merge pull request #19 from rastislavszabo/master
Browse files Browse the repository at this point in the history
README changes
  • Loading branch information
rastislavs committed Jul 28, 2017
2 parents 0ba0a29 + b037c42 commit 073d2ea
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
1 change: 1 addition & 0 deletions CODINGSTYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
- Use `gofmt` to format all source files.
- Address any issues that were discovered by the `golint` & `govet` tool.
- Follow recommendations in [effective go](https://golang.org/doc/effective_go.html) and [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments).
- Please make sure that each dependency in the `glide.yaml` has a specific `version` defined (a specific commit ID or a git tag).
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,8 @@ either pick an open issue and assign it to yourself or open a new issue and disc

In any case, before submitting your pull request please check the [Coding style](CODINGSTYLE.md)
and cover the newly added code with tests and documentation.

The tool used for managing third-party dependencies is [Glide](https://github.com/Masterminds/glide).
After adding or updating a dependency in `glide.yaml` run `make install-dep` to download
specified dependencies into the vendor folder. Please make sure that each dependency in the `glide.yaml`
has a specific `version` defined (a specific commit ID or a git tag).
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![Build Status](https://travis-ci.org/ligato/cn-infra.svg?branch=master)](https://travis-ci.org/ligato/cn-infra)
[![Coverage Status](https://coveralls.io/repos/github/ligato/cn-infra/badge.svg?branch=master)](https://coveralls.io/github/ligato/cn-infra?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/ligato/cn-infra)](https://goreportcard.com/report/github.com/ligato/cn-infra)
[![GoDoc](https://godoc.org/github.com/ligato/cn-infra?status.svg)](https://godoc.org/github.com/ligato/cn-infra)
[![GitHub license](https://img.shields.io/badge/license-Apache%20license%202.0-blue.svg)](https://github.com/ligato/cn-infra/blob/master/LICENSE.md)

The CN infra is a framework that can be used to build a customized management/control
Expand All @@ -11,7 +12,7 @@ known as "CNFs".

If you are interested in contributing, please see the [contribution guidelines](CONTRIBUTING.md).

# Architecture
## Architecture

![arch](high_level_arch_cninfra.png "High Level Architecture of cn-infra")

Expand All @@ -25,7 +26,7 @@ Brief description:
* status (health check status)
* [Core](core) - lifecycle management of plugins (loading, initialization, unloading)

# Quickstart
## Quickstart
Following code snippet illustrates how to start your own flavour of plugins.
Whole code can be found [here](examples/simple-agent/agent.go).
```
Expand All @@ -42,5 +43,7 @@ func main() {

GoDoc can be browsed [online](https://godoc.org/github.com/ligato/cn-infra).

The tool used for managing third-party dependencies is [Glide](https://github.com/Masterminds/glide). After adding or updating
a dependency in `glide.yaml` run `make install-dep` to download specified dependencies into the vendor folder.

## Contribution:

If you are interested in contributing, please see the [contribution guidelines](CONTRIBUTING.md).

0 comments on commit 073d2ea

Please sign in to comment.