Skip to content

Commit

Permalink
update README with new starter site info
Browse files Browse the repository at this point in the history
  • Loading branch information
ekafyi committed Aug 5, 2019
1 parent 5e8b2d4 commit ada534c
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 4 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,26 @@ Read [introductory post on DEV.to](https://dev.to/ekafyi/make-a-landing-page-for

### Option A: Use the starter to create a _new_ site

🚧 IN PROGRESS 🚧
```sh
# create a new site at the directory "my-band-site"
gatsby new my-band-site https://github.com/ekafyi/starter-musician-theme

# go to the site directory
cd my-band-site

# start your site
gatsby develop
```

### Option B: Manually add to your existing site

```sh
npm install --save gatsby-theme-musician
# or
```

or

```sh
yarn add gatsby-theme-musician
```

Expand Down Expand Up @@ -112,6 +125,7 @@ content
│   ├── favicon.png
│ └── placeholder.png
├── releases.yml
├── sample-page.mdx
└── shows.yml
```

Expand Down
47 changes: 47 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Getting Started

💡 _If you have never used Gatsby before, head to their [quick start guide](https://www.gatsbyjs.org/docs/quick-start/) or [beginner-friendly tutorials](https://www.gatsbyjs.org/tutorial/)._

### Option A: Use the starter to create a _new_ site

```sh
# create a new site at the directory "my-band-site"
gatsby new my-band-site https://github.com/ekafyi/starter-musician-theme

# go to the site directory
cd my-band-site

# start your site
gatsby develop
```

### Option B: Manually add to your existing site

```sh
npm install --save gatsby-theme-musician
```

or

```sh
yarn add gatsby-theme-musician
```

Add the theme to the `plugins` array in your `gatsby-config.js`:

```javascript
// gatsby-config.js
module.exports = {
plugins: [
{
resolve: "gatsby-theme-musician",
},
],
}
```

Start your site. (This step will copy the necessary theme files to your site.)

```sh
gatsby develop
```
17 changes: 15 additions & 2 deletions theme/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,26 @@ Read [introductory post on DEV.to](https://dev.to/ekafyi/make-a-landing-page-for

### Option A: Use the starter to create a _new_ site

🚧 IN PROGRESS 🚧
```sh
# create a new site at the directory "my-band-site"
gatsby new my-band-site https://github.com/ekafyi/starter-musician-theme

# go to the site directory
cd my-band-site

# start your site
gatsby develop
```

### Option B: Manually add to your existing site

```sh
npm install --save gatsby-theme-musician
# or
```

or

```sh
yarn add gatsby-theme-musician
```

Expand Down

0 comments on commit ada534c

Please sign in to comment.