summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3757427
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# force-ip-protocol
+
+## Description
+
+This library forces other software to use only IPv4 or IPv6 for network connections.
+
+A library will be LD_PRELOADed which replaces function getaddrinfo()
+by its own version. This version limits the available sockets to ones of
+type PF_INET/PF_INTE6 and such limits all network traffic to a certain protocol
+
+## Installation
+
+Please see INSTALL.
+
+## Usage
+
+ipv4 wget http://www.t-online.de
+
+## Authors and acknowledgment
+
+Please see AUTHORS.
+
+## License
+
+This software is licensed under GPL-2.0-only.
+