diff --git a/README.md b/README.md index 49c6e42..f2d5586 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ # SK8plotlib + Turn any matplotlib line chart into a line skateboarding game. + +> [!CAUTION] +> SK8plotlib is in pre-alpha. Expect bugs. Software provided without warranty, yada yada. + +## Installation + +Install from PyPI with: + +```bash +pip install sk8plotlib +``` + +## Use + +Turn any matplotlib line chart into a skatepark with: + +```python +from sk8plotlib import sk8plotlib + +# ... create a matplotlib figure + +sk8plotlib(fig) +``` + +Alternatively, you can load example maps by running SK8plotlib on the command line, such as by doing: + +```bash +python -m sk8plotlib +```