Skip to content

Commit ec51d17

Browse files
committed
Update README and CHANGELOG
1 parent beca226 commit ec51d17

File tree

2 files changed

+99
-53
lines changed

2 files changed

+99
-53
lines changed

CHANGELOG.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [3.1.0] - 2019-04-12
10+
### Added
11+
* Changelog as a seperate file, based on [keepachangelog](https://keepachangelog.com/de/1.0.0/)
12+
13+
### Changed
14+
* Update all packages to their latest version
15+
* Update babel to include polyfills based on usage
16+
* Restructure webpack configuration files to remove redundant code
17+
18+
### Removed
19+
* Removed `shrink-ray` library, due to it needing node-gyp which caused
20+
many problems interfering with the ease-of-use of this template
21+
22+
## [3.0.0] - 2018-09-28
23+
### Added
24+
* Introduces PostCSS to enable autoprefixer, since support of older browser (looking at you IE) is still important.
25+
* Implement eslint and basic configuration.
26+
* Implements basic test engine using jest.
27+
28+
### Changed
29+
* Switched from EJS for templating to basic HTML using template string interpolation.
30+
This change allows for much more flexibility, i.e. with [react-helmet](https://github.com/nfl/react-helmet)
31+
and dynamically requiring content, such as styles.
32+
* Improves production build by executing steps in parallel.
33+
34+
## [2.5.0] - 2018-09-16
35+
### Changed
36+
* Switched to babel 7
37+
* Switched to nodemon for watch mode
38+
39+
## [2.4.0] - 2018-06-07
40+
### Added
41+
* CSS chunking is back, thanks to the now webpack 4 compliant version of [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin)
42+
* Special thanks to [@zackljackson](https://github.com/zackljackson) for making this possible
43+
44+
## [2.3.0] - 2018-05-31
45+
### Added
46+
* Implements server-side compression via [shrink-ray](https://github.com/aickin/shrink-ray)
47+
* Compression is only enabled in production mode
48+
* Thanks to [@zackljackson](https://github.com/zackljackson) for the hint on shrink-ray
49+
* Implements [helmet](https://github.com/helmetjs/helmet) for security-relevant response headers
50+
51+
## [2.2.1] - 2018-05-26
52+
### Changed
53+
* Exclude the node_modules directory from babel-transpilation to avoid errors when using other libraries like material-ui
54+
55+
## [2.2.0] - 2018-05-17
56+
### Added
57+
* Implements code-splitting via [react-universal-component](https://github.com/faceyspacey/react-universal-component)
58+
as well as an example for using it.
59+
* Implements configuration for [babel-preset-env](https://babeljs.io/docs/plugins/preset-env) to make actual use of the preset
60+
61+
### Changed
62+
* Replaces [stage-0](https://babeljs.io/docs/plugins/preset-stage-0/) with [stage-2](https://babeljs.io/docs/plugins/preset-stage-2/) babel-plugin
63+
due to it being a more advanced and stable spec
64+
65+
### Removed
66+
* Removes `cssHash` from the application, since the [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin)
67+
is no longer implemented since version 2.0.0 of this template
68+
* There are plans to switch to [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin),
69+
but since it does not yet support HMR, I am gonna wait on that a little
70+
71+
Thanks to [@arkhamRejek](https://github.com/arkhamRejek) for contributing the code-splitting feature
72+
as well as the babel-preset changes!
73+
74+
## [2.1.0] - 2018-05-02
75+
### Added
76+
* Implements [react-helmet](https://github.com/nfl/react-helmet) to provide improved handling for document meta information
77+
78+
## [2.0.0] - 2018-04-17
79+
### Changed
80+
* Upgraded to webpack 4
81+
* Upgraded to React 16.3
82+
83+
### Removed
84+
* Removed extract-css-chunks plugin in favor of extract-text-webpack-plugin,
85+
since the former is not supported with webpack 4 anymore
86+
* Removes extract plugins for styles in development, to improve hot-reloading
87+
88+
89+
[Unreleased]: https://github.com/rherwig/template-react-ssr/compare/3.1.0...HEAD
90+
[3.1.0]: https://github.com/rherwig/template-react-ssr/compare/3.0.0...3.1.0
91+
[3.0.0]: https://github.com/rherwig/template-react-ssr/compare/2.5.0...3.0.0
92+
[2.5.0]: https://github.com/rherwig/template-react-ssr/compare/2.4.0...2.5.0
93+
[2.4.0]: https://github.com/rherwig/template-react-ssr/compare/2.3.0...2.4.0
94+
[2.3.0]: https://github.com/rherwig/template-react-ssr/compare/2.2.0...2.3.0
95+
[2.2.1]: https://github.com/rherwig/template-react-ssr/compare/2.2.0...2.2.1
96+
[2.2.0]: https://github.com/rherwig/template-react-ssr/compare/2.1.0...2.2.0
97+
[2.1.0]: https://github.com/rherwig/template-react-ssr/compare/2.0.0...2.1.0
98+
[2.0.0]: https://github.com/rherwig/template-react-ssr/compare/1.0.0...2.0.0

README.md

Lines changed: 1 addition & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -142,59 +142,7 @@ After setting up the configuration, start debugging by either selecting
142142
keyboard.
143143

144144
## Changelog
145-
The following changes have been implemented in the course of developing
146-
the template.
147-
148-
### 3.0.0
149-
* Switched from EJS for templating to basic HTML using template string interpolation.
150-
This change allows for much more flexibility, i.e. with [react-helmet](https://github.com/nfl/react-helmet)
151-
and dynamically requiring content, such as styles.
152-
* Introduces PostCSS to enable autoprefixer, since support of older browser (looking at you IE) is still important.
153-
* Implement eslint and basic configuration.
154-
* Implements basic test engine using jest.
155-
* Improves production build by executing steps in parallel.
156-
157-
### 2.5.0
158-
* Switched to babel 7
159-
* Switched to nodemon for watch mode
160-
161-
### 2.4.0
162-
* CSS chunking is back, thanks to the now webpack 4 compliant version of [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin)
163-
* Special thanks to [@zackljackson](https://github.com/zackljackson) for making this possible
164-
165-
### 2.3.0
166-
* Implements server-side compression via [shrink-ray](https://github.com/aickin/shrink-ray)
167-
* Compression is only enabled in production mode
168-
* Thanks to [@zackljackson](https://github.com/zackljackson) for the hint on shrink-ray
169-
* Implements [helmet](https://github.com/helmetjs/helmet) for security-relevant response headers
170-
171-
### 2.2.0
172-
* Implements code-splitting via [react-universal-component](https://github.com/faceyspacey/react-universal-component)
173-
as well as an example for using it.
174-
* Replaces [stage-0](https://babeljs.io/docs/plugins/preset-stage-0/) with [stage-2](https://babeljs.io/docs/plugins/preset-stage-2/) babel-plugin
175-
due to it being a more advanced and stable spec
176-
* Implements configuration for [babel-preset-env](https://babeljs.io/docs/plugins/preset-env) to make actual use of the preset
177-
* Removes `cssHash` from the application, since the [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin)
178-
is no longer implemented since version 2.0.0 of this template
179-
* There are plans to switch to [mini-css-extract-plugin](https://github.com/webpack-contrib/mini-css-extract-plugin),
180-
but since it does not yet support HMR, I am gonna wait on that a little
181-
182-
Thanks to [@arkhamRejek](https://github.com/arkhamRejek) for contributing the code-splitting feature
183-
as well as the babel-preset changes!
184-
185-
### 2.1.0
186-
* Implements [react-helmet](https://github.com/nfl/react-helmet) to provide improved handling for document meta information
187-
188-
### 2.0.1
189-
* Extends .editorconfig
190-
* Adds .prettierrc to enable formatting via [prettier](https://prettier.io)
191-
192-
### 2.0.0
193-
* Upgraded to webpack 4
194-
* Upgraded to React 16.3
195-
* Removed extract-css-chunks plugin in favor of extract-text-webpack-plugin,
196-
since the former is not supported with webpack 4 anymore
197-
* Removes extract plugins for styles in development, to improve hot-reloading
145+
For a detailed changelog, please refer to the [CHANGELOG.md](CHANGELOG.md).
198146

199147
## Planned features
200148
The following features are planned for future upgrades of the template.

0 commit comments

Comments
 (0)