add links to the guide and examples from docs

zeromq · Jun 2, 2021 · 379bf90 · 379bf90
1 parent 097ade6
commit 379bf90
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -47,9 +47,14 @@ For pyzmq-|release|, this is |target_libzmq|.
 Using PyZMQ
 ===========
 
+To get started with ZeroMQ, read `the ZeroMQ guide <https://zguide.zeromq.org>`_,
+which has every example implemented using PyZMQ.
+
+You can also check out the `examples in the pyzmq repo <https://github.com/zeromq/pyzmq/tree/HEAD/examples>`_.
+
 .. toctree::
     :maxdepth: 2
-    
+
     api/index.rst
     changelog.rst
     draft.rst
@@ -66,7 +71,7 @@ Notes from developing PyZMQ
 
 .. toctree::
     :maxdepth: 2
-    
+
     pyversions.rst
     unicode.rst
 

diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,8 @@
+# pyzmq examples
+
+These are some examples of using pyzmq,
+especially where pyzmq adds something beyond standard libzmq bindings,
+such as integrations with eventloops,
+security and serialization features, etc.
+
+The best source of pyzmq examples for getting started with ZeroMQ is [the ZeroMQ guide](https://zguide.zeromq.org).