diff --git a/.gitignore b/.gitignore index 023f513..1400a18 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,6 @@ node_modules # translation cache and temporary translation folder .json-autotranslate-cache src/data/locales/ + +# generated method document exports +specs/ diff --git a/README.md b/README.md index 6e9ebca..dc7368b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,41 @@ ## Create a new APIOps project (CLI) +Interactive scaffold: + ```bash npm create apiops@latest ``` -This command runs the `create-apiops` initializer package and generates a starter APIOps project template in your current directory. This is useful for a scaffolded proces (with or without AI) to create or review requirements for new APIs or improve existing APIs. +Named project scaffold: + +```bash +npm create apiops@latest report-conversion-apiops +``` + +Non-interactive scaffold: + +```bash +npm create apiops@latest -- --name report-conversion-apiops --locale en --cycle api-productization-cycle --style REST --yes +``` + +When using `npm create`, pass initializer flags after the `--` separator. Flags before the separator are handled by npm itself and may not reach `create-apiops`. + +To inspect the initializer options without starting prompts: + +```bash +npm create apiops@latest -- --help +``` + +Useful options: + +- `--name ` or the first positional argument sets the project directory and package name +- `--locale ` sets the default method locale, such as `en` or `fi` +- `--cycle ` sets the APIOps cycle used for station labels, stakeholders, and recommended resources; default: `api-productization-cycle` +- `--style