diff options
author | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2015-04-06 21:27:57 +0900 |
---|---|---|
committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2015-04-06 21:28:42 +0900 |
commit | 3296c9f978804fe15210267fb56a9ac9b0eb5104 (patch) | |
tree | 992fed0914f4d78b95eb5f65fddec31a0680ef29 /README.md | |
parent | 5256fbe1ca083e02c37c41b4f79f9451f7ddd82b (diff) |
docs: add getting started doc link to README
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 14 insertions, 8 deletions
@@ -1,12 +1,13 @@ -GoBGP: BGP implementation in Go -=============================== +# GoBGP: BGP implementation in Go <p align="right">[![Build Status](https://travis-ci.org/osrg/gobgp.svg?branch=master)](https://travis-ci.org/osrg/gobgp/builds)</p> + +## Introduction GoBGP is an open source BGP implementation designed from scratch for modern environment and implemented in a modern programming language, [the Go Programming Language](http://golang.org/). -Getting started -=============== +## Getting started + Installing GoBGP is quite easy (only two commands!): ```bash @@ -16,13 +17,18 @@ $ go get github.com/osrg/gobgp/gobgp No dependency hell (library, package, etc) thanks to Go. Now ready to [configure](http://osrg.github.io/gobgp/get-started/). -Contributing to GoBGP -===================== +## Contributing to GoBGP + Awesome! Create a pull request. No CLA, board members, governance, or other mess. -Licensing -========= +## Documentation + +### Using GoBGP + * [Getting Started](https://github.com/osrg/gobgp/blob/master/docs/sources/getting-started.md) + +## Licensing + GoBGP is licensed under the Apache License, Version 2.0. See [LICENSE](https://github.com/osrg/gobgp/blob/master/LICENSE) for the full license text. |