diff --git a/README.md b/README.md new file mode 100644 index 0000000..51f0662 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +[![npm](https://img.shields.io/npm/v/create-computercraft)](https://www.npmjs.com/package/create-computercraft) +[![license](https://img.shields.io/npm/l/create-computercraft)](https://www.npmjs.com/package/create-computercraft) + +# create-computercraft + +A simple tool for creating new ComputerCraft-TS projects. ComputerCraft-TS automatically converts your TypeScript project to a single lua file. + +## Usage + +```sh +npm create computercraft@latest +``` + +## Templates + +- **executable:** A standalone ComputerCraft program. +- **library:** A library for use in other ComputerCraft programs. + +## Contributing + +Contributions are welcome! Please open an issue or submit a pull request. + +## License + +This project is licensed under the ISC License. diff --git a/package.json b/package.json index c16c3de..4356eb7 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "create-computercraft", "version": "1.0.9", - "description": "", + "description": "A simple tool for creating new ComputerCraft projects.", "files": [ "./dist/**/*.js", "./templates/**/*"