Skip to content
This repository has been archived by the owner on Jul 19, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Berthe authored May 3, 2018
1 parent 6bc0867 commit 4fa3ef5
Showing 1 changed file with 4 additions and 41 deletions.
45 changes: 4 additions & 41 deletions packages/create-slate-theme/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,7 @@
# Create Slate Theme
[![npm version](https://badge.fury.io/js/create-slate-theme.svg)](https://badge.fury.io/js/create-slate-theme)

Start a new Slate project with a single command. Defaults to creating a fresh copy of [`Shopify/starter-theme`](https://github.com/Shopify/starter-theme):
# create-slate-theme

## Getting Started
The `create-slate-theme` package enables users to create a new Slate project with a single command.

To get started with a new project, run the following command in your terminal:

```
yarn create slate-theme my-new-theme
```

or if you prefer NPM

```
npm install -g create-slate-theme
create-slate-theme my-new-theme
```

## Custom Starting Points

Instead of using [shopify/starter-theme](https://github.com/Shopify/starter-theme), you can optionally specify your own Github repo or local folder to copy as a starting point:

```
yarn create slate-theme my-new-theme shopify/skeleton-theme
```

or

```
yarn create slate-theme my-new-theme my-old-theme/
```

You can share your starting point with the community by publishing your own starter theme to Github. For example, I could publish my own starter theme in the t-kelly/custom-starter-theme repo and then start a new project with it by calling:

```
yarn create slate-theme my-new-theme t-kelly/custom-starter-theme
```

## Options

#### --skipInstall

Skips installing theme dependencies which greatly speeds up overall setup time.
For more information, visit [the Wiki](https://github.com/Shopify/slate/wiki/Create-Slate-Theme).

0 comments on commit 4fa3ef5

Please sign in to comment.