diff --git a/docs/index.rst b/docs/index.rst index 1e8278b..f24ab88 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,6 +5,8 @@ Welcome to Pigeon's documentation! :maxdepth: 2 :caption: Contents: +Pigeon is a combination of a `STOMP client`_, and a message definition system using `Pydantic`_ models. The message definitions can either be defined manually, or Pigeon can search for message definitions via Python entry-points. A template for message definitions is available `here`_. + .. autoclass:: pigeon.Pigeon :members: