Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gunjan5 committed Jan 24, 2017
1 parent 81e35fd commit e9ca9ed
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
[![Build Status](https://semaphoreci.com/api/v1/calico/libcalico-go/branches/master/badge.svg)](https://semaphoreci.com/calico/libcalico-go)[![Slack Status](https://slack.projectcalico.org/badge.svg)](https://slack.projectcalico.org) [![IRC Channel](https://img.shields.io/badge/irc-%23calico-blue.svg)](https://kiwiirc.com/client/irc.freenode.net/#calico)
[![Build Status](https://semaphoreci.com/api/v1/calico/libcalico-go/branches/master/shields_badge.svg)](https://semaphoreci.com/calico/libcalico-go) [![Slack Status](https://slack.projectcalico.org/badge.svg)](https://slack.projectcalico.org) [![IRC Channel](https://img.shields.io/badge/irc-%23calico-blue.svg)](https://kiwiirc.com/client/irc.freenode.net/#calico) [![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](http://godoc.org/github.com/projectcalico/libcalico-go)

# libcalico-go
This repositiory contains Calico's Go components:

- `libcalico`, which can be imported as `"github.com/projectcalico/libcalico-go/lib"`

This library is used by both `calicoctl`, `calico-cni` and `felix`.

If you are looking for the golang version of `calicoctl` it is in the process of moving and
can be found in our
[calico-containers repo / golang branch](https://github.com/projectcalico/calico-containers/tree/golang).
This library is used by:
- [calicoctl](https://github.com/projectcalico/calicoctl)
- [Calico CNI plugin](https://github.com/projectcalico/calico-cni)
- [Calico libnetwork plugin](https://github.com/projectcalico/libnetwork-plugin)
- [felix](https://github.com/projectcalico/felix).

If you wish to use libcalico for integration with Calico networking and
policy, the main entry point to managing Calico configuration is through
the client.

- Documentation for the client is in `lib/client`.
- The resource structure definitions are defined in `lib/api`, this
- Documentation for the client is in [lib/client GoDoc](https://godoc.org/github.com/projectcalico/libcalico-go/lib/client).
- The resource structure definitions are defined in [lib/api](https://godoc.org/github.com/projectcalico/libcalico-go/lib/api), this
includes detailed per-resource and per-field level descriptions.

- Resource definitions can be found in [Calico docs](http://docs.projectcalico.org/master/reference/calicoctl/resources/)
- This repository also includes the implementation for Calico IPAM which can be found in `lib/client`

If you are developing against the code in libcalico, please run the tests before
submitting a Pull Request.
Expand Down

0 comments on commit e9ca9ed

Please sign in to comment.