README.rst (#4)

Nasdaq · Jan 29, 2024 · f407c0e · f407c0e
1 parent fbd7035
commit f407c0e
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 11 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,34 @@
+Welcome to nasdaq-protocols's documentation!
+============================================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   docs/install
+   docs/user_guide
+   docs/developer_guide
+   LICENSE
+
+
+Introduction
+------------
+This library provides a Python implementation of the Nasdaq protocols and FIX protocol.
+
+Following protocols are planned to be implemented in this repository:
+1. SOUP
+2. OUCH
+3. ITCH
+4. FIX
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+
+