aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJavan Makhmali <javan@javan.us>2018-02-14 15:44:38 -0500
committerJavan Makhmali <javan@javan.us>2018-02-14 15:44:38 -0500
commit43b166ad5115fb72a6edd3e416988b9fb75f5ee3 (patch)
treeb19a7c153c7014c8dee67569f0e8396b4290e22e /README.md
parent6054f044c1bb07ca939e40660b58045128bf6f45 (diff)
downloadrails-43b166ad5115fb72a6edd3e416988b9fb75f5ee3.tar.gz
rails-43b166ad5115fb72a6edd3e416988b9fb75f5ee3.tar.bz2
rails-43b166ad5115fb72a6edd3e416988b9fb75f5ee3.zip
Add basic install guide
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 56 insertions, 1 deletions
diff --git a/README.md b/README.md
index 07e2238c34..9c0b8d777b 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,56 @@
-# activetext
+# Active Text
+
+πŸ€Έβ€β™‚οΈπŸ’°πŸ“
+
+## Installing
+
+Assumes a Rails 5.2+ application with Active Storage and Webpacker installed.
+
+1. Install the gem:
+
+ ```ruby
+ # Gemfile
+ gem "activetext", github: "basecamp/activetext", require: "active_text"
+ gem "mini_magick" # for Active Storage variants
+ ```
+
+1. Install the npm package:
+
+ ```js
+ // package.json
+ "dependencies": {
+ "activetext": "basecamp/activetext"
+ }
+ ```
+
+ ```sh
+ $ yarn install
+ ```
+
+ ```js
+ // app/javascript/packs/application.js
+ import "activetext"
+ ```
+
+1. Declare text columns as Active Text attributes:
+
+ ```ruby
+ # app/models/message.rb
+ class Message < ActiveRecord::Base
+ active_text_attribute :content
+ end
+ ```
+
+1. Replace form `text_area`s with `active_text_field`s:
+
+ ```erb
+ <%# app/views/messages/_form.html.erb %>
+ <%= form_with(model: message) do |form| %>
+ …
+ <div class="field">
+ <%= form.label :content %>
+ <%= form.active_text_field :content %>
+ </div>
+ …
+ <% end %>
+ ```