diff --git a/README.md b/README.md index b0cf8c4..621e974 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,37 @@ + + # PyDroid -PyDroid is an open-source project that aims to provide Python access to the Starwars Galaxy's Edge droid depot droids. It allows users to manually control their custom built droids -using custom applications. +PyDroid is an open-source project that aims to provide Python access to the Starwars Galaxy's Edge droid depot droids. It allows users to manually control their custom built droids using custom applications. -## License -PyDroid is released under the MIT license. See the LICENSE file for more details. +## Installation + +PyDroid can be installed using `pip`, or by downloading the source code and running the `setup.py` script. + +### Installing with pip + +To install PyDroid using `pip`, simply run: + +``` +pip install pydroid +``` + +### Installing from source +To install PyDroid from source, follow these steps: + +1. Download the source code from the [GitHub repository](https://github.com/thetestgame/pydroid). +2. Extract the contents of the archive to a directory of your choice. +3. Navigate to the directory containing the `setup.py` script. +4. Run the following command: + +``` +python setup.py install +``` + +## Examples + +PyDroid comes with a few examples to help users get started. These examples can be found under the `examples` directory in the repository root. + +## License +PyDroid is released under the MIT license. See the LICENSE file for more details. \ No newline at end of file