From 69cb0beb369945e3db0421db354bdd3226522769 Mon Sep 17 00:00:00 2001 From: TC Johnson Date: Mon, 4 Sep 2023 11:07:50 -0500 Subject: [PATCH] Make Python README a bit more descriptive Adding in a little more text to help the reader better understand what this module is, its prereqs, and point to the demo app as an example how an app is structured. --- veilid-python/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/veilid-python/README.md b/veilid-python/README.md index 40f4ce29..b7756ddc 100644 --- a/veilid-python/README.md +++ b/veilid-python/README.md @@ -1,4 +1,9 @@ # Veilid Bindings for Python +Create an application in Python using the distributed [Veilid](https://veilid.com) framework for app-to-app communication. + +## Prerequisites +* A headless Veilid node must be installed on the same host as the Python application. Install instructions can be found [here](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md) +* Veilid Python makes heavy use of async and other bleeding edge functions requiring Python version >= 3.11.4 ## Usage @@ -23,3 +28,6 @@ To update schema for validation with the latest copy from a running `veilid-serv ``` ./update_schema.sh ``` + +## Basic Veilid App Setup +A demo chat application is available to review [here](https://gitlab.com/veilid/python-demo). \ No newline at end of file