MatthiesenXYZ/astro-ghostcms
MatthiesenXYZ
/
astro-ghostcms
1
0
Fork 0
Code Issues Pull Requests Projects Releases 125 Activity

update readme

This commit is contained in:
Adam Matthiesen 2024-01-27 18:39:09 -08:00
parent 9f2b8226e4
commit b4c0ba3d45
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
packages/create-astro-ghostcms/README.md
View File

@ -4,6 +4,8 @@ Utility to quickly get started with our Integration and astro.
![Demo](./src/assets/create-astro-ghostcms-2024.jan.27.png) ![Demo](./src/assets/create-astro-ghostcms-2024.jan.27.png)
The Default install method requires `pnpm` if you dont have `pnpm` installed you can change this by using the `--pkg-manager <pkg-mngr>` with the Package manager of your choice(i.e npm, yarn).
```sh ```sh
npx @matthiesenxyz/create-astro-ghostcms npx @matthiesenxyz/create-astro-ghostcms
@ -12,6 +14,17 @@ npx @matthiesenxyz/create-astro-ghostcms
npx @matthiesenxyz/create-astro-ghostcms <template> <project_directory> npx @matthiesenxyz/create-astro-ghostcms <template> <project_directory>
``` ```
## Available command args:
```sh
npx @matthiesenxyz/create-astro-ghostcms --<arg>
# `--help` : Calls internal getHelp Function
# `--install` : Sets Install Dependencies to 'true'
# `--git` : Initiates git Repo
# `--dry` : Shows you what the command will do. (NO CHANGES WILL BE MADE)
# `--pkg-manager`: Specify your Package manager(i.e. npm, yarn | DEFAULT: pnpm)
```
## Available templates ## Available templates
| Template | Description | | Template | Description |