diff --git a/README.md b/README.md index 85a7e80..bb7dd88 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ -# pesde scripts +# pesde/scripts_core -This repository hosts scripts & utilities for [pesde](https://github.com/daimond113/pesde) +Discord +Lune +pesde/scripts_core + + + + +Scripts and other utilities for use with pesde. + +## Prerequisites + +To ensure proper functionality, please make sure you have the following dependencies installed: + +- **pesde**: Version `>= 0.5.0-rc.15` +- **lune**: Version `>= 0.8.9` + +## Usage + +For example, to install Rojo scripts, run: + +```sh +# Add the scripts themselves +pesde add --dev pesde/scripts_rojo --target lune +# Add the Rojo CLI +pesde add --dev pesde/rojo --target lune +# Install dependencies +pesde install +``` + +If a sync tool you would like is not present here, please open an issue or submit a PR, following the format of one of the existing tools. + + + +# License + +This project is licensed under the [MIT](https://github.com/pesde-pkg/scripts/blob/master/LICENSE) license.