diff --git a/packages/create-opub-app/README.md b/packages/create-opub-app/README.md index 15c81038..5617f820 100644 --- a/packages/create-opub-app/README.md +++ b/packages/create-opub-app/README.md @@ -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] @@ -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 @@ -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 diff --git a/packages/create-opub-app/assets/cli-design.png b/packages/create-opub-app/assets/cli-design.png new file mode 100644 index 00000000..ca3edbca Binary files /dev/null and b/packages/create-opub-app/assets/cli-design.png differ