aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoronur1 <onur1@onurgunduz.com>2023-05-24 23:42:25 +0200
committeronur1 <onur1@onurgunduz.com>2023-05-24 23:42:25 +0200
commit16037dca662bad709d9d70b5645103aeedddf4ac (patch)
tree6436ec9ac4b7d66d79bb43d6edfc09166cfc965f
parentfddba43d583755774d5861fc39cab18b0b3e18fc (diff)
downloadmuxer-16037dca662bad709d9d70b5645103aeedddf4ac.tar.gz
muxer-16037dca662bad709d9d70b5645103aeedddf4ac.zip
Update docs
-rw-r--r--README.md10
-rw-r--r--binproto.go2
2 files changed, 3 insertions, 9 deletions
diff --git a/README.md b/README.md
index 1748132..490d26a 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,3 @@
# binproto
-binproto implements generic support for binary-based request response protocols. You can use it to create your own binary network protocols for things like RPC or file transfer.
-
-![Build](https://github.com/onur1/binproto/actions/workflows/main.yml/badge.svg)
-
-[**See the full API documentation at pkg.go.dev**](https://pkg.go.dev/github.com/onur1/binproto)
-
-[**Getting started tutorial**](https://onurgunduz.com/binproto)
-
-[Report a bug or suggest a feature](https://github.com/onur1/binproto/issues)
+binproto implements low-level support for binary-based two-way communication protocols. You can use it to create your own low-latency binary protocols for things like game networking or file transfer.
diff --git a/binproto.go b/binproto.go
index 016c87c..4c5842a 100644
--- a/binproto.go
+++ b/binproto.go
@@ -1,3 +1,5 @@
+// Package binproto implements low-level support for binary-based two-way
+// communication protocols.
package binproto
import (