diff --git a/README.md b/README.md index 77b91b4..8f4889b 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,9 @@ specified depencencies are not hosted on that index. ## Usage -`skyeweave` is a CLI application, meaning it needs to be accessed via the commandline. +### commandline + +`skyeweave` is primarily a CLI application. The following options are available: @@ -39,6 +41,18 @@ skyeweave --output out --id 70 This would generate the expressions for Scathach (Servant Id 70) in the folder out, using subfolders to better separate the outputs of multiple runs. +### python scripts [EXPERIMENTAL] + +`skyeweave` can also be used in other Python scripts. + +```python +from skyeweave import compose + +compose(70) +``` + +This feature will be expanded upon in future releases. + ## Issues / Support If there are any issues with `skyeweave`, feel free to reach out to me using the AtlasAcademy discord (`#dev-corner`) or create an issue in this repo. diff --git a/test.py b/test.py new file mode 100644 index 0000000..038687a --- /dev/null +++ b/test.py @@ -0,0 +1,3 @@ +from skyeweave import compose + +compose(70)