Skip to content

Commit

Permalink
CLI: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
= committed Feb 7, 2024
1 parent ae58873 commit 9b3a995
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion packages/create-opub-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm create opub-app

## Arguments

The CLI takes a single argument, the name of the project and options to choose a template and package manager.
The CLI takes optinal arguments

```bash
npm create opub-app [package-name] [options]
Expand All @@ -26,6 +26,8 @@ eg: npm create opub-app my-opub-app -e d4d -m pnpm

- `-e, --example` - An example to bootstrap the app with. `[d4d | data-exchange]`
- `-m, --manager` - Explicitly tell the CLI to bootstrap the application using specific package manager. `[npm | pnpm | yarn | bun]`
- `--noGit` - Explicitly tell the CLI to not initialize a new git repo in the project
- `--noInstall` - Explicitly tell the CLI to not run the package manager's install command

## Tech Stack

Expand All @@ -35,6 +37,12 @@ eg: npm create opub-app my-opub-app -e d4d -m pnpm
- [tar](https://github.com/isaacs/node-tar) - extract tar compressed file
- [@vercel/ncc ](https://github.com/vercel/ncc)- compile Node.js modules into a single file

## Design

The CLI is designed to be as simple as possible. It asks for the project name, options and does some validations. It then fetches the template from the OPub GitHub repository and extracts it to the current working directory.

![OPub CLI Design](./assets/cli-design.png)

## Next Steps

- [x] Test in various environments
Expand Down
Binary file added packages/create-opub-app/assets/cli-design.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9b3a995

Please sign in to comment.