Skip to content

Commit

Permalink
fix: Correcting broken readme links
Browse files Browse the repository at this point in the history
  • Loading branch information
rschristian committed Aug 8, 2022
1 parent 4225cfd commit e5eb731
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions packages/create-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `create-preact-cli`

> Start building a [Preact] Progressive Web App in seconds 🔥
> Start building a [Preact](https://github.com/preactjs/preact) Progressive Web App in seconds 🔥
This will become the method for creating new Preact-CLI projects in v4.

Expand All @@ -22,19 +22,19 @@ Example:
$ npm init preact-cli default my-project
```

The above command pulls the template from [preactjs-templates/default], prompts for some information, and generates the project at `./my-project`.
The above command pulls the template from [preactjs-templates/default](https://github.com/preactjs-templates/default), prompts for some information, and generates the project at `./my-project`.

### Official Templates

The purpose of official preact project templates are to provide opinionated development tooling setups so that users can get started with actual app code as fast as possible. However, these templates are un-opinionated in terms of how you structure your app code and what libraries you use in addition to preact.js.

All official project templates are repos in the [preactjs-templates organization]. When a new template is added to the organization, you will be able to run `npm init preact-cli <template-name> <project-name>` to use that template.
All official project templates are repos in the [preactjs-templates organization](https://github.com/preactjs-templates). When a new template is added to the organization, you will be able to run `npm init preact-cli <template-name> <project-name>` to use that template.

Current available templates include:

- [default] - Default template with all features
- [default](https://github.com/preactjs-templates/default) - Default template with all features

- [typescript] - Default template implemented in TypeScript
- [typescript](https://github.com/preactjs-templates/default) - Default template implemented in TypeScript

> 💁 Tip: Any Github repo with a `'template'` folder can be used as a custom template: <br /> `npm init preact-cli <username>/<repository> <project-name>`
Expand Down

0 comments on commit e5eb731

Please sign in to comment.