From 312697bfa42ab3165158e5defddbfd511b99355d Mon Sep 17 00:00:00 2001 From: Stephen Asbury Date: Thu, 16 May 2019 14:18:32 -0700 Subject: [PATCH] Added intro to developer doc with links to javadoc/godoc/etc... --- SUMMARY.md | 2 ++ developer/README.md | 12 ++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 developer/README.md diff --git a/SUMMARY.md b/SUMMARY.md index 5a3a49c..c627812 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -45,6 +45,8 @@ ## Developing With NATS +* [Intro](developer/README.md) + * [Concepts](developer/concepts/intro.md) * [Subject-Based Messaging](developer/concepts/subjects.md) * [Publish-Subscribe](developer/concepts/pubsub.md) diff --git a/developer/README.md b/developer/README.md new file mode 100644 index 0000000..9770369 --- /dev/null +++ b/developer/README.md @@ -0,0 +1,12 @@ +# Developing with NATS + +Developing with NATS is a combination of distributed application techniques, common NATS features and library specific syntax. As well as using this book for guidance, some of the libraries contain language-familiar formats of their API. For example, the go library has go doc, and the Java library has javadoc. + +| Library | Doc Link | +| ------------- | ------------- | +| [nats.go](https://github.com/nats-io/nats.go) | [godoc](http://godoc.org/github.com/nats-io/nats.go) | +| [nats.java](https://github.com/nats-io/nats.java) | [javadoc](https://javadoc.io/doc/io.nats/jnats) | +| [nats.net](https://github.com/nats-io/nats.net) | [doxygen](http://nats-io.github.io/nats.net/) | +| [nats.rb](https://github.com/nats-io/nats.rb) | [yard](https://www.rubydoc.info/gems/nats) | + +Not all libraries contain this separate doc, depending on the language community, but be sure to check out the client libraries README for more information. \ No newline at end of file