1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..468643d
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+--- Haxe Unix Sockets ---
+
+Haxe bindings for Unix sockets.
+
+The following targets are supported:
+  - C++
+
+--- Installation ---
+
+$ haxelib git haxe-unix-sockets https://git.rc-05.com/haxe-unix-sockets
+
+--- Documentation ---
+
+The documentation is available at https://docs.rc-05.com/haxe-unix-sockets/git
+for the unstable version.
+
+--- License ---
+
+This project is licensed with the MIT License which can be viewed by
+reading the LICENSE file supplied with this codebase.