katalyst-navigation 1.4.1 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83045ad7f39df98e03b15381de07ac417d8357755678454dc2e72f0d629b6b78
-  data.tar.gz: 4fbdd6dbca7a65332354e348ede2f9b5c1b61b48f65e28e6798c52298ddb586e
+  metadata.gz: 421e7c0756dfcd5a0faa5cd53e2ab7b9c054e521c4d1b104fc66991a86b12c2a
+  data.tar.gz: 3c0e197a8a3294595215a7125f21ecb29aa642db86e14125d9cad350c074ba0b
 SHA512:
-  metadata.gz: 497fda35e70f9055741573cb6a059c3f140d5dbd70fa4cfbb09ab96b6b8ec27cc9e3bae768428d64ee67da8c9239166635874f013b857859c8e15a7a072fcbc3
-  data.tar.gz: e52b138b2a2c5b5e17b7ce938a86124949ab352d7a75d282481b59a3a8066a1fb032f5346dd897d0b5821298389eea90173cf312a512b03fbcb6916fa59f3978
+  metadata.gz: bebf02888e9b02bd8f8daa71c2b15bd2c00a72cefcf13bcdd97f107fe85800e0b64e80efd1a5d9f576cee1b7aa8986afcdd4c6ea70a541f2317e557b8d0bd3d8
+  data.tar.gz: 7be0bfde5ad4c619cc7998654c9b3d60ffce9ce63f7730df123f4778e8abd6dcb74b6cb57b3f2f4cc6f07744ebfc6d6ac9a7ce141756d9de6c30271f737a98ee

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