summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2015-04-02 23:37:54 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2015-04-02 23:37:54 +0900
commita7f39b6300ec1ed8ed1fa7ef3745c9a93b675500 (patch)
treeae9b1ab7b2769c5c6daf4844ddd67733809f6b8b /README.md
parentb37cda689758e10aa7857c03cae2936f92078abc (diff)
update README.md
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 28 insertions, 2 deletions
diff --git a/README.md b/README.md
index 1133566f..ba88ce2a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
-gobgp
-=====
+GoBGP: BGP implementation in Go
+===============================
+
+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
+===============
+Installing GoBGP is quite easy (only two commands!):
+
+```bash
+$ go get github.com/osrg/gobgp/gobgpd
+$ 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
+=====================
+Awesome! Create a pull request. No CLA, board members, governance, or
+other mess.
+
+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.