Update README and add upgrade guide (#400)

baoagency · Mar 18, 2024 · 9ab98c1 · 9ab98c1
1 parent b04d7dd
commit 9ab98c1
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/.github/assets/preview.png b/.github/assets/preview.png
diff --git a/README.md b/README.md
@@ -35,6 +35,10 @@ Run installer:
 bin/rails polaris_view_components:install
 ```
 
+## Upgrade
+
+Check out [UPGRADING.md](UPGRADING.md) for upgrade instructions.
+
 ## Development
 
 To get started:

diff --git a/UPGRADING.md b/UPGRADING.md
@@ -0,0 +1,13 @@
+# Upgrading guide
+
+## Upgrading to `v2.0.0`
+
+This release updates UI to Polaris v12 styles. Required changes after gem upgrade:
+
+1. Add `polaris_html_classes` to your `html` tag in layouts:
+
+```erb
+<html class="<%= polaris_html_classes %>" style="<%= polaris_html_styles %>">
+```
+
+2. Update icon names in your app. Naming convention in Polaris Icons v12 changed. There's no more separation to `Minor` and `Major` icons. All icons have `Icon` suffix. New icon names can be found in Polaris documentation: https://polaris.shopify.com/icons