Skip to content

Commit

Permalink
(docs): remove version/permalink refs in template READMEs
Browse files Browse the repository at this point in the history
- don't want to have multiple references to versions that need to be
  updated along with package.json changes
  - these are for the most part wrapped by TSDX, so would only need to
    know a version in an advanced use-case, where having to check the
    package.json is not unreasonable
  - we also try to keep up with latest, so if it's bleeding edge or not
    shouldn't be impactful for too long
    - e.g. will be upgrading to Rollup v2 soon enough, no one's even
      requested it, so no need to add changing version in a few places
      to maintenance burden
      - also easy to forget to update and then have outdated/incorrect
        docs

- same jive with permalink to PR -- if it's not already outdated, it's
  likely to become outdated often
  - reference Parcel's aliasing docs instead of PR that adds it
  • Loading branch information
agilgur5 committed May 3, 2020
1 parent d4ff914 commit 76a0530
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions templates/react-with-storybook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ 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**, [we use Parcel's aliasing](https://github.com/palmerhq/tsdx/pull/88/files).
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**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).

To do a one-off build, use `npm run build` or `yarn build`.

To run tests, use `npm test` or `yarn test`.

## Configuration

Code quality is [set up for you](https://github.com/palmerhq/tsdx/pull/45/files) with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.

### Jest

Expand Down Expand Up @@ -82,7 +82,7 @@ We do not set up `react-testing-library` for you yet, we welcome contributions a

### Rollup

TSDX uses [Rollup v1.x](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.

### TypeScript

Expand Down
6 changes: 3 additions & 3 deletions templates/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ 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**, [we use Parcel's aliasing](https://github.com/palmerhq/tsdx/pull/88/files).
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**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).

To do a one-off build, use `npm run build` or `yarn build`.

To run tests, use `npm test` or `yarn test`.

## Configuration

Code quality is [set up for you](https://github.com/palmerhq/tsdx/pull/45/files) with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.

### Jest

Expand Down Expand Up @@ -66,7 +66,7 @@ We do not set up `react-testing-library` for you yet, we welcome contributions a

### Rollup

TSDX uses [Rollup v1.x](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.

### TypeScript

Expand Down

0 comments on commit 76a0530

Please sign in to comment.