Relicense: Use the LGPL v2.1 (or later) for liboping.
[liboping.git] / README
diff --git a/README b/README
index b12fd5d..474a8dd 100644 (file)
--- a/README
+++ b/README
@@ -1,37 +1,54 @@
- liboping - Library to ping IPv4 and IPv6 hosts in parallel
-============================================================
+ liboping  Library to ping IPv4 and IPv6 hosts in parallel
+════════════════════════════════════════════════════════════
 http://verplant.org/liboping/
 
 About
------
+━━━━━
 
   liboping was inspired by ping, libping and fping: It differs from these
-  existing solutions in that it can `ping' multiple hosts in parallel using
+  existing solutions in that it can “ping” multiple hosts in parallel using
   IPv4 or IPv6 transparently. Other design principles were an object oriented
   interface, simplicity and extensibility.
 
+  On top of liboping two command line applications have been built. “oping” is
+  a drop-in replacement for ping(1) with very similar output. “noping” is an
+  ncurses-based application which displays statistics while pinging and
+  highlights aberrant round-trip times.
+
 
 Features
---------
+━━━━━━━━
 
-  * Support for multiple hosts.
+   Support for multiple hosts.
 
-  * Support for IPv4 and IPv6.
+   Support for IPv4 and IPv6.
 
-  * Object oriented interface.
+   Object oriented interface.
 
 
 Perl bindings
--------------
+━━━━━━━━━━━━━
 
   Included in the source package of liboping are bindings for Perl. The code
   resides in the bindings/ subdirectory and is compiled and installed by
-  default. To disable building the Perl bindings, call `configure' with
-  `--without-perl-bindings'.
+  default. To disable building the Perl bindings, call “configure” with
+  “--without-perl-bindings”.
+
+
+Licensing terms
+━━━━━━━━━━━━━━━
+
+  liboping is licensed under the “GNU Lesser General Public License” (LGPL),
+  version 2.1 or later. The exact licensing terms can be found in the file
+  “COPYING” included in the source distribution of liboping.
+
+  The “oping” and “noping” utilities included in this package are licensed
+  under the “GNU General Public License” (GPL), version 2. The full licensing
+  terms can be found online at <http://www.gnu.org/licenses/gpl-2.0.html>.
 
 
 Author
-------
+━━━━━━
 
   Florian octo Forster <octo at verplant.org>