Permalink
Browse files

First documentation

  • Loading branch information...
1 parent dde5d65 commit 891cdeea62cf5c3e8abfcc87da4cdf50c610c3c8 @bortzmeyer committed Dec 27, 2012
Showing with 55 additions and 1 deletion.
  1. +55 −1 README.md
View
@@ -1,4 +1,58 @@
GoRTR
=====
-A RTR (router to RPKI cache/validator protocol) library for writing RTR clients
+A RTR (router to RPKI cache/validator protocol) library for writing RTR clients.
+
+Background
+----------
+
+The general architecture of RPKI is described in RFC 6480. The RFC
+about the RTR protocol is not yet published.
+
+Usage
+-----
+
+This library is written in [Go](http://golang.org), so you need a Go compiler
+installed.
+
+ go doc rtr/rtr.go
+
+to see the usage documentation. Or read the two samples clients,
+text-client.go (displays the prefixes received) or
+database-store-client.go (store the prefixes in a PostgreSQL database
+created with database-store-create.sql)
+
+Reference site
+--------------
+[At Github](https://github.com/bortzmeyer/GoRTR)
+
+Licence
+-------
+Copyright (c) 2012, Stephane Bortzmeyer
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice,
+ this list of conditions and the following disclaimer in the documentation
+ and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+Author
+------
+
+Stephane Bortzmeyer <bortzmeyer@nic.fr>

0 comments on commit 891cdee

Please sign in to comment.