Skip to content

Commit

Permalink
(docs): remove duplicative "Using the Playground" section
Browse files Browse the repository at this point in the history
- these directions already exist in the "Commands" section, so no need
  to duplicate them

- also consistently call it "example plaground"
- and fix order and grammar in Storybook "Commands" section that
  references both
  • Loading branch information
agilgur5 committed May 3, 2020
1 parent 356bbda commit f360f9b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 23 deletions.
14 changes: 2 additions & 12 deletions templates/react-with-storybook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ npm start # or yarn start

This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.

Then run either example playground or storybook:
Then run either Storybook or the example playground:

### Storybook

Expand Down Expand Up @@ -120,17 +120,7 @@ CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.

## Using the Playground

```
cd example
npm i # or yarn to install dependencies
npm start # or yarn start
```

The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**!

## Deploying the Playground
## Deploying the Example Playground

The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):

Expand Down
12 changes: 1 addition & 11 deletions templates/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,7 @@ CJS, ESModules, and UMD module formats are supported.

The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.

## Using the Playground

```bash
cd example
npm i # or yarn to install dependencies
npm start # or yarn start
```

The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**!

## Deploying the Playground
## Deploying the Example Playground

The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):

Expand Down

0 comments on commit f360f9b

Please sign in to comment.