summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Pevzner <pzz@apevzner.com>2020-01-14 11:23:55 +0300
committerAlexander Pevzner <pzz@apevzner.com>2020-01-14 11:23:55 +0300
commitbe4b4b13833d0b449e039d3a5dba6cb179ab7269 (patch)
treedf42273277598dde6eff50349c7cdf562430f501
parentb92954803fd873d0ab3e90c8f697d85f302f77f1 (diff)
README.md updated
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index c1738eb..e35356f 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,13 @@
[![godoc.org](https://godoc.org/github.com/alexpevzner/goipp?status.svg)](http://godoc.org/github.com/alexpevzner/goipp)
![GitHub](https://img.shields.io/github/license/alexpevzner/goipp)
-IPP core protocol implementation in pure Go
+The goipp library is fairly complete implementation of IPP core protocol in
+pure Go. Essentially, it is IPP messages parser/composer. Transport is
+not implemented here, because Go standard library has an excellent built-in
+HTTP client, and it doesn't make a lot of sense to wrap it here.
+
+High-level requests, like "print a file" are also not implemented, only the
+low-level stuff.
+
+All documentation is on godoc.org -- follow the link above. Pull requests
+are welcomed, assuming they don't break existing API.