Skip to content

Commit

Permalink
docs: add usage section with detailed info about project addition
Browse files Browse the repository at this point in the history
  • Loading branch information
UlisesGascon committed Dec 3, 2024
1 parent 0088847 commit a99a1c5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,22 @@ To seed the database with initial data, use the following command:
npm run db:seed
```

## Usage

### Projects

To add a new project, use the following command:

```bash
node index.js project add [--name <name>] [--github-urls <urls...>] [--category <category>]
```

For example, to add a project named "express" with GitHub URLs:

```bash
node index.js project add --name express --github-urls https://github.com/expressjs https://github.com/pillarjs https://github.com/jshttp --category impact
```

## Debug mode

This project uses the [debug library](https://www.npmjs.com/package/debug), so you can always use the environmental variable `DEBUG=*` to print more detailed information of the execution.
Expand Down

0 comments on commit a99a1c5

Please sign in to comment.