readme

kscalelabs · Sep 20, 2024 · 256fc17 · 256fc17
1 parent ba2be0d
commit 256fc17
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,20 @@
 
 Defines a package to make it easy to control actuators.
 
+## Getting Started
+
+Install the package:
+
+```bash
+pip install actuator
+```
+
+Alternatively, to install the bleeding edge version from Github:
+
+```bash
+pip install 'actuator @ git+https://github.com/kscalelabs/actuator.git@master'
+```
+
 ## Supported Actuators
 
 - [Robstride](https://robstride.com/)