qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject [50/50] [abbrv] qpid-proton git commit: PROTON-827: Update README to mention online documentation.
Date Tue, 08 Sep 2015 16:38:08 GMT
PROTON-827: Update README to mention online documentation.


Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/64acd38f
Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/64acd38f
Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/64acd38f

Branch: refs/heads/proton-go
Commit: 64acd38f6d6c647ed10903a27d32e01d211b5d73
Parents: 763032d
Author: Alan Conway <aconway@redhat.com>
Authored: Fri May 29 15:23:30 2015 -0400
Committer: Alan Conway <aconway@redhat.com>
Committed: Thu Jul 16 17:37:46 2015 -0400

----------------------------------------------------------------------
 proton-c/bindings/go/README.md | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/64acd38f/proton-c/bindings/go/README.md
----------------------------------------------------------------------
diff --git a/proton-c/bindings/go/README.md b/proton-c/bindings/go/README.md
index 2b73583..0f16b8e 100644
--- a/proton-c/bindings/go/README.md
+++ b/proton-c/bindings/go/README.md
@@ -1,20 +1,19 @@
 # *EXPERIMENTAL* Go binding for proton
 
-    NOTE: The go directory is in the proton repository root with a symlink at
-    proton-c/bindings/go to facilitate use of go tools: go get, godep and godoc.
-    There may be a cleaner solution to this in future.
+This is an *experimental* [Go](http://golang.org) binding for proton.
+The API is subject to change but there is enough to get a good idea of where it is headed.
 
-This is the beginning of a [Go](http://golang.org) binding for proton.
-
-This work is in early *experimental* stages, *everything* may change in future.
-Comments and contributions are strongly encouraged, this experiment is public so
-early feedback can guide development.
+Feedback is strongly encouraged:
 
 - Email <proton@qpid.apache.org>
 - Create issues <https://issues.apache.org/jira/browse/PROTON>, attach patches to an
issue.
 
-There are working [examples](../examples/go/README.md) and the examples README file
-explains how to install the packages in your go workspace and read the documentation.
+The package documentation is available at: <http://godoc.org/qpid.apache.org/proton/go>
+
+See the [examples](../../../examples/go/README.md) for working examples and
+practical instructions on how to get started.
+
+The rest of this page discusses the high-level goals and design issues.
 
 ## Goals
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message