]> git.deb.at Git - rhonda/impostor.hazel.git/commitdiff
Expanded Readme a bit
authorJamie <Jamster.30@btinternet.com>
Sun, 17 Jul 2016 15:16:39 +0000 (16:16 +0100)
committerGitHub <noreply@github.com>
Sun, 17 Jul 2016 15:16:39 +0000 (16:16 +0100)
README.md

index dadf89ccd19c11903dd2e50a82a4950670cca67e..12e0cab927fd12200e2b52464393a0bb04443b0e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,21 @@
 ### Hazel Networking is a low level networking library for C# providing connection orientated, message based communication via TCP, UDP and RUDP. 
 
+####Features
+- TCP, UDP, Reliable UDP and (at some point) Web Sockets
+- Completely thread safe
+- All protocols are connection orientated (similar to TCP) and message based (similar to UDP)
+- Standardised interface so that all protocols can be used interchangeably with each other
+- IPv4 and IPv6 support
+- Automatic statistics about data passing in and out of connections
+- Designed to be as fast and leightweight as possible
+- Continued support as it's improved and maintained for DarkRift 2
+
+Hazel Networking is an open source, low level networking library for C# providing connection orientated, message based communication via TCP, UDP and RUDP. It's aim is to provide a standardised interface for web communication so that using and switching between protocols is incredibly simple.
+
+Hazel is going to be the basis of DarkRift 2 and I'm releasing it completely open source so that members of the community can make use of it, improve it and help find any bugs before DarkRift 2 is released.
+
 #### Hazel is currently in beta; things should (but might not) work!
 
-Documentation available [here](http://www.darkriftnetworking.com/docs).
+HTML documentation, tutorials and quickstarts are available on the DarkRift Website [here](http://www.darkriftnetworking.com/docs); support is available through [email](jamie@darkriftnetworking.com) or alternatively Hazel has a thread on the [Unity forum](http://forum.unity3d.com/threads/hazel-networking-open-source-rudp-tcp-library.409863/) where you'll also find updates and other news.
 
-If you want to make improvements, please do!
+If you want to make improvements, do so! If you find bugs, raise issues!