summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoachim Nilsson <troglobit@gmail.com>2019-09-28 13:50:03 +0200
committerJoachim Nilsson <troglobit@gmail.com>2019-09-28 13:50:51 +0200
commite7489ad4463ba48eaa0a2e6cc8b248cd251a9bbd (patch)
tree4928437fbb365e408b49ef63f4c19f0c6e2551a8
parent3146177d8ed23b32d19965a4420186a8759bbc2d (diff)
downloadlibnet-e7489ad4463ba48eaa0a2e6cc8b248cd251a9bbd.tar.gz
Overhaul new README.md; promote GitHub and simplify
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
-rw-r--r--README.md57
1 files changed, 31 insertions, 26 deletions
diff --git a/README.md b/README.md
index ac98cc0..d884ff7 100644
--- a/README.md
+++ b/README.md
@@ -1,40 +1,45 @@
-[![Build status](https://ci.appveyor.com/api/projects/status/9ic7kmwektgornlg?svg=true)](https://ci.appveyor.com/project/sgeto/libnet) [![Build Status](https://travis-ci.org/sgeto/libnet.svg?branch=master)](https://travis-ci.org/sgeto/libnet)
+[![Appveyor Status][]][Appveyor] [![Travis Status][]][Travis]
-# Libnet #
+A C library for portable packet creation and injection
+======================================================
-Libnet provides a fairly portable framework for network packet construction
-an injection.
+Libnet is an API to help with the construction and handling of network
+packets. It provides a portable framework for low-level network packet
+writing and handling (use libnet in conjunction with libpcap and you can
+write some really cool stuff). Libnet includes packet creation at the
+IP layer and at the link layer as well as a host of supplementary and
+complementary functionality. Libnet is very handy with which to write
+network tools and network test code. See the manpage and sample test
+code for more detailed information.
-It is widely used, but had become unmaintained at packetfactory.net, and its
-author is unreachable.
+> **NOTE:** Legacy code written for *libnet-1.0.x* WILL NOT WORK with
+> *libnet-1.1.x*. Read *doc/MIGRATION* for porting legacy code.
-This version was forked from the 1.1.3 release candidate, then bug fixed,
-actively maintained, and rereleased.
+**LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman <mike@infonexus.com>**
+http://www.packetfactory.net/libnet
-Contact Sam Roberts <vieuxtech@gmail.com> if you have patches, find bugs, or
-have issues porting or building against it.
+**LIBNET 1.1.3 and later (c) 2009 - 2013 Sam Roberts <vieuxtech@gmail.com>**
+http://github.com/sam-github/libnet
-Newest code is at:
- http://github.com/sam-github/libnet
+Origin & References
+-------------------
-Releases are at:
+Libnet is widely used, but had become unmaintained at packetfactory.net,
+and its author is unreachable. This version was forked from the 1.1.3
+release candidate from packetfactory.net, then bug fixed, actively
+maintained, and rereleased.
- http://sourceforge.net/projects/libnet-dev/
+Use GitHub issues and pull request feature for questions and patches:
-Some old docs are at:
+ http://github.com/libnet/libnet
- http://packetfactory.openwall.net/projects/libnet/index.html
+Some old docs are available at:
-**A C library for portable packet creation and injection**
-
-Libnet is an API to help with the construction and handling of network packets. It provides a portable framework for low-level network packet writing and handling (use libnet in conjunction with libpcap and you can write some really cool stuff). Libnet includes packet creation at the IP layer and at the link layer as well as a host of supplementary and complementary functionality. Libnet is very handy with which to write network tools and network test code. See the manpage and sample test code for more detailed information.
-
-Your old code (circa *libnet-1.0.x*) WILL NOT WORK with *libnet-1.1.x*.
-Read *doc/MIGRATION* for easy steps on porting your old code.
+ http://packetfactory.openwall.net/projects/libnet/index.html
-**LIBNET 1.1 (c) 1998 - 2004 Mike D. Schiffman <mike@infonexus.com>**
-http://www.packetfactory.net/libnet
-**LIBNET 1.1.3 and later (c) 2009 - 2013 Sam Roberts <vieuxtech@gmail.com>**
-http://github.com/sam-github/libnet \ No newline at end of file
+[Appveyor]: https://ci.appveyor.com/project/sgeto/libnet
+[Appveyor Status]: https://ci.appveyor.com/api/projects/status/9ic7kmwektgornlg?svg=true
+[Travis]: https://travis-ci.org/libnet/libnet
+[Travis Status]: https://travis-ci.org/libnet/libnet.png?branch=master