Skip to content

Commit 356bbda

Browse files
committed
(docs): improve consistency in template READMEs
- basically `diff templates/react/README.md templates/react-with-storybook/README.md` should only show the Storybook differences - make code block annotation are consistent - one had bash and shell and the other didn't - also use txt instead of shell for file structure - file structure isn't a shell command - make `np` link consistent - the React w/ Storybook README should say its with Storybook, not just for plain React to be explicit
1 parent 76a0530 commit 356bbda

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

templates/react-with-storybook/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TSDX React User Guide
1+
# TSDX React w/ Storybook User Guide
22

33
Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
44

@@ -12,7 +12,7 @@ TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based]
1212

1313
The recommended workflow is to run TSDX in one terminal:
1414

15-
```
15+
```bash
1616
npm start # or yarn start
1717
```
1818

@@ -24,7 +24,7 @@ Then run either example playground or storybook:
2424

2525
Run inside another terminal:
2626

27-
```
27+
```bash
2828
yarn storybook
2929
```
3030

@@ -36,7 +36,7 @@ This loads the stories from `./stories`.
3636

3737
Then run the example inside another:
3838

39-
```
39+
```bash
4040
cd example
4141
npm i # or yarn to install dependencies
4242
npm start # or yarn start
@@ -60,7 +60,7 @@ Jest tests are set up to run with `npm test` or `yarn test`.
6060

6161
This is the folder structure we set up for you:
6262

63-
```
63+
```txt
6464
/example
6565
index.html
6666
index.tsx # test your component here in a demo app
@@ -161,7 +161,7 @@ For vanilla CSS, you can include it at the root directory and add it to the `fil
161161

162162
## Publishing to NPM
163163

164-
We recommend using https://github.com/sindresorhus/np.
164+
We recommend using [np](https://github.com/sindresorhus/np).
165165

166166
## Usage with Lerna
167167

templates/react/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Jest tests are set up to run with `npm test` or `yarn test`.
4444

4545
This is the folder structure we set up for you:
4646

47-
```shell
47+
```txt
4848
/example
4949
index.html
5050
index.tsx # test your component here in a demo app

0 commit comments

Comments
 (0)