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/bc72b8be Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/bc72b8be Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/bc72b8be Branch: refs/heads/proton-go Commit: bc72b8bed4a8b231f8828278a0b15d5d37af6c2b Parents: e964480 Author: Alan Conway <[email protected]> Authored: Fri May 29 15:23:30 2015 -0400 Committer: Alan Conway <[email protected]> Committed: Mon Sep 28 14:08:23 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/bc72b8be/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 <[email protected]> - 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: [email protected] For additional commands, e-mail: [email protected]
