Skip to content

Commit

Permalink
Merge pull request #514 from projectcalico/casey-reame-upd
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
caseydavenport authored Sep 14, 2017
2 parents a3291af + 145564a commit 7eb7610
Showing 1 changed file with 27 additions and 19 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,42 @@
[![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:
<img src="http://docs.projectcalico.org/images/felix.png" width="100" height="100">

- `libcalico`, which can be imported as `"github.com/projectcalico/libcalico-go/lib"`
This repository contains the internal library for interacting with the Calico data store as well as common source code used across Calico components. Note that the APIs defined in this library are not guaranteed to be forwards or backwards compatible and may change at any time without notice.

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.
Calico is a Tigera open source project, and is primarily maintained by the Tigera team. However any members of the community – individuals or organizations – are welcome to get involved and contribute to the project.

- 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`
## Get Started Using Calico

If you are developing against the code in libcalico, please run the tests before
submitting a Pull Request.
For users who want to learn more about the project or get started with Calico, see the documentation on [docs.projectcalico.org](https://docs.projectcalico.org).

## Get Started Developing Calico

### Making changes to libcalico-go

Contributions to this code are welcome! The code in this repository can be built and tested using the Makefile.

To run the tests locally (requires a full golang environment Go 1.7+):

make ut

To run the tests within a containerized environment:
To run the tests within a containerized environment (requires a [functioning Docker installation](https://docs.docker.com/engine/installation/)):

make test-containerized

For more information on available targets, see `make help`.

### Developing against libcalico-go

If you wish to use libcalico for integrating 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 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.




0 comments on commit 7eb7610

Please sign in to comment.