From 3a5520bd1aaa6a5bb4c12ef6404d2ce0048bec68 Mon Sep 17 00:00:00 2001
From: Cameron Devine <cameron.devine@alleninstitute.org>
Date: Wed, 12 Jun 2024 13:25:20 -0700
Subject: [PATCH] updating docs with message library template

---
 docs/index.rst | 2 ++
 1 file changed, 2 insertions(+)

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<https://pypi.org/project/stomp-py/>`_, and a message definition system using `Pydantic<https://docs.pydantic.dev/latest/>`_ 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<https://github.com/AllenInstitute/pigeon-msgs-cookiecutter>`_.
+
 .. autoclass:: pigeon.Pigeon
    :members: