Skip to content

Commit

Permalink
docs: create a README.md file for the project (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
nekofar authored Nov 1, 2023
1 parent cd0efac commit 05deaec
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
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.

0 comments on commit 05deaec

Please sign in to comment.