README.md in theme-check-0.1.2 vs README.md in theme-check-0.2.0
- old
+ new
@@ -2,11 +2,11 @@
Think RuboCop, or eslint, but for Shopify themes.
Theme Check is a command line tool that helps you follow Shopify Themes & Liquid best practices by analyzing the Liquid & JSON inside your theme.
-Theme Check is also available [inside some code editors](https://github.com/Shopify/theme-check/wiki).
+Code editor support coming soon!
![](docs/preview.png)
_Disclaimer: This tool is not supported as part of the Partners program._
@@ -29,15 +29,33 @@
✅ Missing default locale file
✅ Unmatching translation keys in locale files
✅ Using unknown translation keys in `{{ 'missing_key' | t }}`
✅ Using several `{% ... %}` instead of `{% liquid ... %}`
✅ Undefined [objects](https://shopify.dev/docs/themes/liquid/reference/objects)
+✅ Deprecated filters
And many more to come! Suggestions welcome ([create an issue](https://github.com/Shopify/theme-check/issues)).
+## Requirements
+
+- Ruby 2.7+
+
## Installation
+Theme Check is available through Homebrew _or_ RubyGems.
+
+**Homebrew**
+
+You’ll need to run `brew tap` first to add Shopify’s third-party repositories to Homebrew.
+
+```sh
+brew tap shopify/shopify
+brew install theme-check
```
+
+**RubyGems**
+
+```sh
gem install theme-check
```
## Usage