diff --git a/README.md b/README.md new file mode 100644 index 0000000..bccef49 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Shulkerscript cli tool + +This is a cli tool for the shulkerscript language. It can be used to initialize a new project, and to compile and package a project. + +## Installation +```bash +cargo install --git https://github.com/moritz-hoelting/shulkerscript +``` + +## Usage + +### Initialize a new project +```bash +shulkerscript init [OPTIONS] [PATH] +``` +Where [PATH] is the path of the folder to initialize in [default: .] + +Options: +- `--name ` The name of the project +- `--description ` The description of the project +- `--pack-format ` The pack format version +- `--force` Force initialization even if the directory is not empty