summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJiri Pirko <jiri@resnulli.us>2013-08-08 10:41:03 +0200
committerJiri Pirko <jiri@resnulli.us>2013-08-08 10:41:03 +0200
commit18183fd2fe717f874f2a9e6be6f5072cfff36ce5 (patch)
treee184a5dd3756364006628086098585ed052e99ff
parentaf67f0c3a54ed06d62c704a84d462ebf029fb970 (diff)
downloadlibndp-18183fd2fe717f874f2a9e6be6f5072cfff36ce5.tar.gz
update README
Signed-off-by: Jiri Pirko <jiri@resnulli.us>
-rw-r--r--README35
1 files changed, 29 insertions, 6 deletions
diff --git a/README b/README
index e36e5e0..656eb02 100644
--- a/README
+++ b/README
@@ -1,8 +1,31 @@
-libndp
+# libndp - Library for Neighbor Discovery Protocol #
-How to install:
-$ ./autogen.sh
-$ ./configure
-$ make
-$ make install
+This package contains a library which provides a wrapper
+for IPv6 Neighbor Discovery Protocol. It also provides a tool
+named ndptool for sending and receiving NDP messages.
+
+## Install
+
+LNST can be installed using python's distutils.
+
+ $ ./autogen.sh
+ $ ./configure
+ $ make
+ $ sudo make install
+
+## Authors
+
+* Jiri Pirko <jiri@resnulli.us>
+
+## Internet Resources
+
+* Project Home: http://www.libndp.org/
+* Git Source Tree: https://github.com/jpirko/libndp
+
+## License
+
+Copyright (C) 2013 Jiri Pirko <jiri@resnulli.us>
+
+libndp is distributed under GNU Lesser General Public License version 2.1.
+See the file "COPYING" in the source distribution for information on terms & conditions for accessing and otherwise using libndp.