diff --git a/README.md b/README.md index 8236ed0..3febef5 100644 --- 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/)