Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
goznauk committed Dec 4, 2019
1 parent 55c0d47 commit 085916c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Despite all the recent hype, setting up a new TypeScript (x React) library can b
- [`tsdx lint`](#tsdx-lint)
- [Author](#author)
- [License](#license)
- [Contributors ✨](#contributors-%e2%9c%a8)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -54,7 +55,7 @@ TSDX comes with the "battery-pack included" and is part of a complete TypeScript

## Quick Start

```
```bash
npx tsdx create mylib
cd mylib
yarn start
Expand Down
10 changes: 5 additions & 5 deletions templates/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based]

The recommended workflow is to run TSDX in one terminal:

```
```bash
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 the example inside another:

```
```bash
cd example
npm i # or yarn to install dependencies
npm start # or yarn start
Expand All @@ -44,7 +44,7 @@ Jest tests are set up to run with `npm test` or `yarn test`. This runs the test

This is the folder structure we set up for you:

```
```shell
/example
index.html
index.tsx # test your component here in a demo app
Expand Down Expand Up @@ -106,7 +106,7 @@ The appropriate paths are configured in `package.json` and `dist/index.js` accor

## Using the Playground

```
```bash
cd example
npm i # or yarn to install dependencies
npm start # or yarn start
Expand Down Expand Up @@ -145,7 +145,7 @@ For vanilla CSS, you can include it at the root directory and add it to the `fil

## Publishing to NPM

We recommend using https://github.com/sindresorhus/np.
We recommend using [np](https://github.com/sindresorhus/np).

## Usage with Lerna

Expand Down

0 comments on commit 085916c

Please sign in to comment.