diff --git a/README.md b/README.md new file mode 100644 index 0000000..440049c --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Create Nounish App + +A Node.js package to generate a new Nounish app using a simple command. + +## Installation + +Install the package globally using pnpm: + +```bash +pnpm install -g create-nounish-app +``` + +## Usage + +To create a new Nounish app, run the following command: + +```bash +create-nounish-app --name my-nounish-app +``` + +This will create a new directory `my-nounish-app` with a basic template for a Nounish app. + +### Arguments + +- `--name ` (required): The name of the app to create. + +## Development + +For development, clone the repository and install the dependencies: + +```bash +git clone https://github.com/your-username/create-nounish-app.git +cd create-nounish-app +pnpm install +``` + +To build the project, run: + +```bash +pnpm run build +``` + +## License + +This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.