Merge pull request #39 from Automattic/update/release-instructions

Add release instructions

Author: thingalon

README.md

@@ -72,3 +72,13 @@ async function playwrightGenerator( urls: string[] ): Promise< string > {
 	return css;
 }
 ```
+
+# Releasing new version
+- Update the const `version` in `src/index.ts`
+- Update version number in `package.json`
+- Commit your changes
+- Create a new release in [jetpack-boost-critical-css-gen](https://github.com/Automattic/jetpack-boost-critical-css-gen/releases/new)
+	- Create a new tag in the release with the release version with the format `release-x.x.x`
+	- The release title will be the same as the tag.
+	- Click "Generate release notes" to automatically generate new release note.
+	- Publish

package.json

@@ -1,8 +1,8 @@
 {
 	"name": "jetpack-boost-critical-css-gen",
 	"main": "./lib/index.js",
-	"description": "Critical CSS Generator capable of running in-browser (iframes) or on server-side (NodeJS + Puppeteer). Built for use with Jetpack Boost.",
-	"version": "0.0.6",
+	"description": "Critical CSS Generator capable of running in-browser (iframes) or on server-side (NodeJS + playwright). Built for use with Jetpack Boost.",
+	"version": "0.0.9",
 	"license": "GPL-2.0-or-later",
 	"type": "module",
 	"scripts": {

src/index.ts

@@ -6,4 +6,4 @@ export { generateCriticalCSS } from './generate-critical-css';
 
 export * from './errors';
 
-export const version = '0.0.6';
+export const version = '0.0.9';