From 94f2e97aa5787f420fbde474a99cf63ad8f3f5de Mon Sep 17 00:00:00 2001
From: Alex Davies <traverse.da@gmail.com>
Date: Thu, 19 Sep 2024 11:20:08 -0300
Subject: [PATCH] Updated README

---
 README.md | 34 ++++++++++++++++++++++++++++++++--
 1 file changed, 32 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 426e6bb..216a121 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,33 @@
-New SDK
+# Spiri SDK - Simulated robot
 
-toDo, usage instructions
+The Spiri SDK consists of a number of components. What you're looking at right now 
+is the drone simulation component, which is the core of the SDK.
+
+Spiri Robots run a number of docker containers to achieve their core functionality,
+we try to keep these essential docker containers in one docker compose file. The 
+docker compose file you'll find in this repository start an ardupilot-based UAV simulation
+as well as a ROS master, and mavproxy to tie it together.
+
+To get started you can simply clone this repository and run `docker compose --profile uav-sim`.
+
+Once the simulated UAV is running you can connect to it with QGroundControl or other
+MavLink compatible software. We expose the UAVs Mavlink conenction on tcp port 5760.
+
+## Creating a new project
+
+We provide project templates you can use for development that integrate seamlessly into
+our simulated robots.
+
+To get started with our project templates install the [copier](https://copier.readthedocs.io/en/stable/) project
+templating utility.
+
+ * [template-service-ros1-catkin](https://git.spirirobotics.com/Spiri/template-service-ros1-catkin)
+
+This template uses the last stable release of ROS1 (ros noetic) and supports python and c++ programming 
+languages.
+
+ROS1 is considered end of life. It's recomended to use a ROS2 template instead
+
+ * ROS2 template
+
+We're working on it...