Skip to content

Commit 5ac0744

Browse files
Add upgrade instructions
1 parent faa29ed commit 5ac0744

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This gem assumes that you'll load the rest of the CSS asyncronously. At the mome
88

99
This gem uses [Penthouse](https://github.com/pocketjoso/penthouse) to generate the critical CSS.
1010

11-
## Update
11+
## Upgrading to the Latest Release
1212

13-
Versions below 0.3.0 are not compatible with this version. Please read the Upgrading from Previous Versions section below for more information.
13+
Upgrade instructions from each version are included below.
1414

1515
## Installation
1616

@@ -110,7 +110,10 @@ Careful use of these methods allows the developer to generate critical path CSS
110110

111111
A user can use these methods to [dynamically generate critical path CSS](https://gist.github.com/taranda/1597e97ccf24c978b59aef9249666c77) without using the `rake critical_path_css:generate` rake task and without hardcoding the application's routes into `config/critical_path_css.yml`. See [this Gist](https://gist.github.com/taranda/1597e97ccf24c978b59aef9249666c77) for an example of such an implementation.
112112

113-
## Upgrading from Previous Versions
113+
## Upgrading from version 0.X.X to 1.0.0
114+
To maintain the latest version of Penthouse, this gem now depends on NodeJS and NVM to be installed on the system.
115+
116+
## Upgrading from a version earlier than 0.3.0
114117

115118
The latest version of Critcal Path CSS Rails changes the functionality of the `generate` method. In past versions,
116119
`generate` would produce CSS for all of the routes listed in `config/critical_path_css.yml`. This functionality has been replaced by the `generate_all` method, and `generate` will only produce CSS for one route.

0 commit comments

Comments
 (0)