Update README and CHANGELOG

neofinancial · Aug 30, 2019 · 8211ee3 · 8211ee3
1 parent b4abec0
commit 8211ee3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,8 @@
-## 0.3.2 (Aug 27 2019)
+## 0.3.3 (August 30, 2019)
+
+- Revert `@typescript-eslint/promise-function-async` rule due to performance issues
+
+## 0.3.2 (August 27, 2019)
 
 - `@typescript-eslint/promise-function-async` on
 - `require-await` off (conflicts with above)

diff --git a/README.md b/README.md
@@ -129,3 +129,12 @@ No. If you want to do this, you have to ask the team. If a rule really doesn't m
 **Can I disable the rule on one line in my code, I have a good reason.**
 
 Yes. That's ok. Use a single-line disable.
+
+## Publishing
+
+1. Update the version in `package.json`
+1. Create a `CHANGELOG` entry
+1. Commit your changes
+1. `npm pack` to see what will be published then delete the `.tgz` file that was created
+1. `npm publish`
+1. Create a release on GitHub. Use the version as the tag and release name. For example for version `1.0.0` the tag and release name would be `v1.0.0`. Add the `CHANGELOG` details to the release.