Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ A new snapshot release will be created with your changes and tagged on NPM with
yarn add @shopify/hydrogen@unstable

# or start a new project:
npx create-hydrogen-app@unstable
npx @shopify/create-hydrogen@unstable
```

## Releasing experimental versions
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ Spin up a Hydrogen app in your browser with our [playground](https://hydrogen.ne

```bash
# Using `yarn`
yarn create hydrogen-app
yarn create @shopify/hydrogen

# Using `npm`
npm init hydrogen-app@latest
npm init @shopify/hydrogen

# Using `npx`
npx create-hydrogen-app
npx @shopify/create-hydrogen
```

**Running locally:**
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The `hydrogen/cli` package provides interactive project scaffolding for Hydrogen apps and other useful commands to help you build on `@shopify/hydrogen`.

> Note:
> The CLI doesn't currently generate the [Demo Store template](https://shopify.dev/custom-storefronts/hydrogen/templates). Run `npx create-hydrogen-app` to scaffold a new project with the Demo Store template. To contribute to the Demo Store template, update the [template files](https://github.com/Shopify/hydrogen/tree/main/templates/demo-store).
> Run `npx @shopify/create-hydrogen` to scaffold a new project with the Demo Store template. To contribute to the Demo Store template, update the [template files](https://github.com/Shopify/hydrogen/tree/main/templates/template-hydrogen-default).

## Installation

Expand Down
2 changes: 1 addition & 1 deletion packages/create-hydrogen-app/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@
And update the `preview` script in your `package.json`:

```diff
- "preview": "npx @shopify/hydrogen-cli@latest preview",
- "preview": "npx @shopify/create-hydrogen-cli@latest preview",
+ "preview": "shopify hydrogen preview",
```

Expand Down
4 changes: 2 additions & 2 deletions packages/create-hydrogen-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
Create a new [Hydrogen](https://www.npmjs.com/package/@shopify/hydrogen) project:

```bash
npm init hydrogen-app@latest
npm init @shopify/hydrogen
```

Or with yarn:

```bash
yarn create hydrogen-app
yarn create @shopify/hydrogen
```
12 changes: 6 additions & 6 deletions templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Hydrogen templates are complete working implementations of Shopify custom storef
## Create a Hydrogen app with the default Demo store template
## Use `--template demo-store` to set the template explicitly
# yarn
$ yarn create hydrogen-app
$ yarn create @shopify/hydrogen
# npm
$ npm init hydrogen-app@latest
$ npm init @shopify/hydrogen
# npx
$ npx create-hydrogen-app
$ npx @shopify/create-hydrogen
```

**Demo Store** is the default template installed when creating a new Hydrogen storefront. It’s a complete Hydrogen storefront that uses live production data provided by Shopify. It includes demonstration implementations of a homepage, product detail pages, collections, data-fetching, caching strategies, Tailwind integration, and more. It showcases Shopify’s opinionated best practices for building storefronts with Hydrogen, and some advanced features of the framework. Pick this template to inspect a working Hydrogen codebase, or to use as a starting point for your own build.
Expand All @@ -22,11 +22,11 @@ $ npx create-hydrogen-app
```sh
## Create a Hydrogen app with the Hello World template
# yarn
$ yarn create hydrogen-app --template hello-world
$ yarn create @shopify/hydrogen --template hello-world
# npm
$ npm init hydrogen-app@latest --template hello-world
$ npm init @shopify/hydrogen --template hello-world
# npx
$ npx create-hydrogen-app --template hello-world
$ npx @shopify/create-hydrogen --template hello-world
```

**Hello World** is a minimal implementation of a Hydrogen app. It has few dependencies and very little boilerplate. Pick this template to start building from scratch.