Skip to content
This repository was archived by the owner on Jun 3, 2019. It is now read-only.

Commit 338ecfd

Browse files
oyeanujSteven Truesdell
authored andcommitted
Minor readme updates (#501)
* Update Webpack version * Update Webpack version * Fix acronym * Fix markdown formatting. * Update that redux branch does not have Flow * Add 'Who is using it' section in the README As per @ctrlplusb’s comment here: #437 (comment) 98854669
1 parent c27f2a9 commit 338ecfd

File tree

4 files changed

+12
-8
lines changed

4 files changed

+12
-8
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This starter kit contains all the build tooling and configuration you need to ki
2424
- 🌍 Server Side Rendering.
2525
- 😎 Progressive Web Application ready, with offline support, via a Service Worker.
2626
- 🐘 Long term browser caching of assets with automated cache invalidation.
27-
- 📦 All source is bundled using Webpack v2.
27+
- 📦 All source is bundled using Webpack v3.
2828
- 🚀 Full ES2017+ support - use the exact same JS syntax across the entire project. No more folder context switching! We also only use syntax that is stage-3 or later in the TC39 process.
2929
- 🔧 Centralised application configuration with helpers to avoid boilerplate in your code. Also has support for environment specific configuration files.
3030
- 🔥 Extreme live development - hot reloading of ALL changes to client/server source, with auto development server restarts when your application configuration changes. All this with a high level of error tolerance and verbose logging to the console.
@@ -61,6 +61,10 @@ Now go make some changes to the `Home` component to see the tooling in action.
6161
- [Deploy your very own Server Side Rendering React App in 5 easy steps](/internal/docs/DEPLOY_TO_NOW.md)
6262
- [Changelog](/CHANGELOG.md)
6363

64+
## Who's using it and where?
65+
66+
You can see who is using it and how in [the comments here](https://github.com/ctrlplusb/react-universally/issues/437). Feel free to add to that telling us how you are using it, we'd love to hear from you.
67+
6468
## Contributors
6569

6670
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

internal/docs/FEATURE_BRANCHES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Below are a list of extensions to this repository, in the form of branches. Eac
1212
- [`apollo`](https://github.com/ctrlplusb/react-universally/tree/feature/apollo) - Adds the Apollo Stack (i.e. Graphql).
1313
- [`mobx`](https://github.com/andreyluiz/react-universally/tree/feature/mobx) - Adds MobX as a state management library.
1414
- [`postcss-sass`](https://github.com/ctrlplusb/react-universally/tree/feature/postcss-sass) - Adds PostCSS and SASS.
15-
- [`redux-opinionated`](https://github.com/ctrlplusb/react-universally/tree/feature/redux-opinionated) - Adds an opinionated Redux implementation, using `redux-thunk` and `react-jobs` to support data loading across the client/server. It also merges in the `flow` feature branch.
15+
- [`redux-opinionated`](https://github.com/ctrlplusb/react-universally/tree/feature/redux-opinionated) - Adds an opinionated Redux implementation, using `redux-thunk` and `react-jobs` to support data loading across the client/server.
1616

1717
If you would like to add a new feature branch log an issue describing your chosen technology and we can come up with a plan together. :)
1818

internal/docs/PKG_SCRIPTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@
99

1010
## `npm run analyze:client`
1111

12-
Creates an 'webpack-bundle-analyze' session against the production build of the client bundle.
12+
Creates an `webpack-bundle-analyze` session against the production build of the client bundle.
1313

1414
## `npm run analyze:server`
1515

16-
Creates an 'webpack-bundle-analyze' session against the production build of the server bundle.
16+
Creates an `webpack-bundle-analyze` session against the production build of the server bundle.
1717

1818
## `npm run build`
1919

@@ -43,10 +43,10 @@ Executes `eslint` against the project. Alternatively you could look to install t
4343

4444
Executes the server. It expects you to have already built the bundles using the `npm run build` command.
4545

46-
## `npm run test`
46+
## `npm run test`
4747

4848
Runs the `jest` tests.
4949

50-
## `npm run test:coverage`
50+
## `npm run test:coverage`
5151

5252
Runs the `jest` tests and generates a coverage report. I recommend you look at [codecov.io](https://codecov.io) to host your coverage reports.

internal/docs/PROJECT_OVERVIEW.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
Below is a general overview of the project.
1111

12-
## TOC
12+
## ToC
1313

1414
- [Bundled by Webpack](#bundled-by-webpack)
1515
- [Transpiled by Babel](#transpiled-by-babel)
@@ -18,7 +18,7 @@ Below is a general overview of the project.
1818

1919
## Bundled by Webpack
2020

21-
This starter uses Webpack 2 to produce bundles for both the client and the server. The `internal/webpack/configFactory.js` is used to generate the respective Webpack configuration for all our bundles. The factory is heavily commented to help you understand what is going on within the Webpack configuration.
21+
This starter uses Webpack 3 to produce bundles for both the client and the server. The `internal/webpack/configFactory.js` is used to generate the respective Webpack configuration for all our bundles. The factory is heavily commented to help you understand what is going on within the Webpack configuration.
2222

2323
> Note: Given that we are bundling our server code I have included the `source-map-support` module to ensure that we still get nice stack traces when executing our code.
2424

0 commit comments

Comments
 (0)