Skip to content

Commit

Permalink
update init documentation to promote my-app option
Browse files Browse the repository at this point in the history
  • Loading branch information
thescientist13 committed Sep 11, 2024
1 parent ead77bd commit 6671e37
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 10 deletions.
23 changes: 17 additions & 6 deletions packages/init/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,33 @@ Init package for scaffolding out a new Greenwood project. For more information
Create a directory and then run the `init` command to scaffold a minimal Greenwood project.

```bash
mkdir my-app && cd my-app
npx @greenwood/init@latest
# providing an output directory of my-app
npx @greenwood/init@latest my-app
```

This will then output the following
This will then output your project files into a directory called _my-app_
```bash
├── greenwood.config.js
my-app
├── .gitignore
├── greenwood.config.js
├── package.json
└── src/
└─ pages/
└─ index.md
└─ ...
```

## API

### Project Name

By providing a name as the first argument will output the project files into a directory of the same name and configure the `name` property _package.json_.

```bash
# example
npx @greenwood/init@latest my-app
```

> _Omitting my-app will install project files into the current directory._
### Template

To scaffold your new project based on one of [Greenwood's starter templates](https://github.com/orgs/ProjectEvergreen/repositories?q=greenwood-template-&type=all&language=&sort=), pass the `--template` flag and then follow the prompts to complete the scaffolding.
Expand Down
2 changes: 1 addition & 1 deletion www/pages/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is the documentation space for **Greenwood** that we hope will help you get


### Installation
Greenwood can be installed with any of the common package managers available today.
Greenwood can be installed manually with any of the common package managers available today or through our [`init` package](/getting-started/quick-start/#init-package).

```bash
# npm
Expand Down
4 changes: 1 addition & 3 deletions www/pages/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ If you want to get right into the code, we have a few options to get you started
You can use Greenwood's [`init` package](https://github.com/ProjectEvergreen/greenwood/blob/master/packages/init/README.md) to scaffold out a new empty Greenwood project, or from a layout.

```bash
mkdir my-app && cd my-app

npx @greenwood/init@latest
$ npx @greenwood/init@latest my-app
```

### Command Line
Expand Down

0 comments on commit 6671e37

Please sign in to comment.