diff --git a/demo/app/pages/overview.md.erb b/demo/app/pages/overview.md.erb new file mode 100644 index 00000000..118fc415 --- /dev/null +++ b/demo/app/pages/overview.md.erb @@ -0,0 +1,36 @@ +--- +title: Polaris ViewComponents +--- + +Polaris ViewComponents is an implementation of the [Polaris Design System](https://polaris.shopify.com/components) using ViewComponents. + +## Example + + + + +## Dependencies + +- [Stimulus](https://stimulus.hotwired.dev/) + +## Installation + +Add polaris_view_components to your Gemfile: + +```bash +bundle add polaris_view_components +``` + +Run installer: + +```bash +bin/rails polaris_view_components:install +``` + +## Source code + +The source code is available on [GitHub](/~https://github.com/baoagency/polaris_view_components). diff --git a/demo/config/application.rb b/demo/config/application.rb index cbf7c306..a5131b5c 100644 --- a/demo/config/application.rb +++ b/demo/config/application.rb @@ -46,5 +46,6 @@ class Application < Rails::Application # Lookbook config.lookbook.project_name = "Polaris ViewComponents" + config.lookbook.page_paths = ["app/pages"] end end