-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: create a README.md file for the project (#4)
- Loading branch information
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <app-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. |