diff --git a/README.md b/README.md new file mode 100644 index 0000000..4aab7eb --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# pesde/tooling + +<a href="https://discord.gg/ATVVsNNv3u"><img alt="Discord" src="https://img.shields.io/discord/385151591524597761?style=plastic&logo=discord&color=%235865F2" /></a> +<a href="https://lune-org.github.io/docs"><img alt="Lune" src="https://raw.githubusercontent.com/pesde/tooling/refs/heads/main/.lune/assets/powered-by-lune.svg" /></a> +<!-- TODO: CI workflow status --> + + Common Luau tooling packaged for pesde, for use within fully pesde-managed projects. + +--- + +<div align="center"> + + | Tool | Available package | +|----------|------------------------------------------------------------------------------------------------------------------------------------:| +| [`pesde/stylua`](https://pesde.daimond113.com/packages/pesde/stylua) |  | +| [`pesde/luau-lsp`](https://pesde.daimond113.com/packages/pesde/luau-lsp) |  | + +</div> + +## Usage + +```sh +pesde x pesde/{TOOL} + +# Or, install the tool into your project and have it accessible in PATH +pesde add --dev pesde/{TOOL} +pesde install +``` + +Where `{TOOL}` corresponds to the name of one of the tools present in this directory. + +If a Luau 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. + +<!-- TODO: Recommend contributors to read CONTRIBUTING.md when that is a thing --> +