docs: add UPGRADE instructions

coverallsapp · Mar 6, 2023 · 28fd5c0 · 28fd5c0
1 parent 30402df
commit 28fd5c0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -0,0 +1,10 @@
+# v1 -> v2
+
+Notable changes:
+
+- **v2** uses [universal coverage reporter](https://github.com/coverallsapp/coverage-reporter) instead of [node-coveralls](https://github.com/nickmerwin/node-coveralls) like in **v1**.
+
+- Option `path-to-lcov` is now deprecated, use `file` instead.
+
+- You can skip `file` option and coveralls will try to find all supported coverage files and combine their data.
+