katalyst-navigation 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83045ad7f39df98e03b15381de07ac417d8357755678454dc2e72f0d629b6b78
-  data.tar.gz: 4fbdd6dbca7a65332354e348ede2f9b5c1b61b48f65e28e6798c52298ddb586e
+  metadata.gz: b7959306448abfc59d046b1ebb116c1866b16ebdf632f505ebdb659afea13e90
+  data.tar.gz: 03660c839246adc0989a6d20835171258eb64182d3308dd5111711108806f8cb
 SHA512:
-  metadata.gz: 497fda35e70f9055741573cb6a059c3f140d5dbd70fa4cfbb09ab96b6b8ec27cc9e3bae768428d64ee67da8c9239166635874f013b857859c8e15a7a072fcbc3
-  data.tar.gz: e52b138b2a2c5b5e17b7ce938a86124949ab352d7a75d282481b59a3a8066a1fb032f5346dd897d0b5821298389eea90173cf312a512b03fbcb6916fa59f3978
+  metadata.gz: 831e2c1d9bcb2f43348e811a9659a0bb64664bc7694ff37ffb9ff146e135966ada5c3c336552717a5fca006b78a2ad7b3208db3cdbd46ee82d7d64dbfe2df273
+  data.tar.gz: 1097aa6c6b8008ae52b4246ab01a7892b23daa3a6f45a50635720616d7f0c5b9d72df511d580fd32b3b222a516d7f61e7965e37af84fdb4f4b2103b046935039

data/README.md

@@ -4,17 +4,41 @@ Generates and edits navigation menus.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem as usual
 
-    $ bundle add katalyst-navigation
+```ruby
+gem "katalyst-navigation"
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Mount the engine in your `routes.rb` file:
 
-    $ gem install katalyst-navigation
+```ruby
+mount Katalyst::Navigation::Engine, at: "navigation"
+```
+
+Add the Gem's migrations to your application:
+
+```ruby
+rake katalyst_navigation:install:migrations
+```
+
+Add the Gem's javascript and CSS to your build pipeline. This assumes that
+you're using `rails-dartsass` and `importmaps` to manage your assets.
+
+```javascript
+// app/javascript/controllers/application.js
+import { application } from "controllers/application";
+import navigation from "@katalyst/navigation";
+application.load(navigation);
+```
+
+```sass
+@use "katalyst/navigation";
+```
 
 ## Usage
 
-This gem is still experimental and is not yet ready for public consumption. See dummy app for example usage.
+See the dummy app for examples.
 
 ## Contributing