From ae7b4a0feaa0bc20899d3c27ca8391d9692784f0 Mon Sep 17 00:00:00 2001
From: hexbabe <sean.xiaochen.yu@gmail.com>
Date: Thu, 30 Nov 2023 17:31:29 -0500
Subject: [PATCH] Improve README

---
 README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d8e6315..26c022f 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
-# python-appimage-example
-Example repo for bundling a Viam module as an AppImage with AppImageBuilder
+# py-container-module
+
+This is an example of using AppImageBuilder to bundle a Python module as an AppImage (only supported on AArch64 for now), and then running it on a robot.
+
+Use this as a reference for:
+- An alternative to managing Python version/dependencies directly
+
+## Robot config
+
+Replace `module_id` and `model` with the values you choose for your module.
+
+```json
+TODO: add example config after the module is on the registry
+```
+
+## Quick tour of this repo
+
+- `packaging/`: The directory containing the Dockerfile that configures the Docker image for the builder, the AppImageBuilder.yml config file, and the icon
+- `src/`: Python code for the Viam module
+- `Makefile`: `make` commands to build the module in different ways
+- `meta.json`: The metadata config file used when uploading/updating module info on the registry
+- `requirements.txt`: List of Python dependencies
+- `run.sh`: The entrypoint execution script that starts up the module process
+
+## Forking this repo
+
+If you fork this and want to deploy to a robot, you'll need to change all placeholder variables, references to 'viam', and optionally set up secrets for CI. Follow the [fork instructions](https://github.com/viam-labs/python-example-module#forking-this-repo) from the Python example repo.