README.md in phraseapp-in-context-editor-ruby-3.1.1 vs README.md in phraseapp-in-context-editor-ruby-3.2.0

- old
+ new

@@ -8,26 +8,28 @@ ### Prerequisites To use phraseapp-in-context-editor-ruby with your application you have to: -* Sign up for a Phrase account: [https://app.phrase.com/signup](https://app.phrase.com/signup) -* Use the excellent [i18n](https://github.com/ruby-i18n/i18n) gem also used by [Rails](https://guides.rubyonrails.org/i18n.html) +- Sign up for a Phrase account: [https://app.phrase.com/signup](https://app.phrase.com/signup) +- Use the excellent [i18n](https://github.com/ruby-i18n/i18n) gem also used by [Rails](https://guides.rubyonrails.org/i18n.html) ### Demo You can find a demo project in the `examples/demo` folder, just run `bundle && rails s` and head to `http://127.0.0.1:3000` Login via the demo credentials `demo@phrase.com` / `phrase` ### Installation #### NOTE: You can not use the old version of the ICE with integration versions of >2.0.0, you have to instead use 1.x.x versions as before + #### via Gem ```bash gem install phraseapp-in-context-editor-ruby ``` + #### via Bundler Add it to your `Gemfile` ``` @@ -82,15 +84,28 @@ Old version of the ICE is not available since version 2.0.0. If you still would rather use the old version, please go back to 1.x.x versions. #### Using the US Datacenter with ICE In addition to the settings in your `config/initializers/phraseapp_in_context_editor.rb`, set the US datacenter to enable the ICE to work with the US endpoints. + ```ruby config.enabled = true config.project_id = "YOUR_PROJECT_ID" config.account_id = "YOUR_ACCOUNT_ID" config.datacenter = "us" ``` + +#### Using with CSP + +The script will automatically get the nonce from `content_security_policy_nonce` +The content_security_policy.rb has to have `:strict_dynamic` for `policy.script_src` since we are loading more scripts dynamically because of our way of deploying + +```ruby + policy.script_src :self, :https, :strict_dynamic + policy.style_src :self, :https +``` + +The `config.content_security_policy_nonce_directives = %w[script-src style-src]` can include `style-src` but this _might_ break some styling in some cases ### Browser support This library might not work out of the box for some older browser or IE11. We recommend to add [Babel](https://github.com/babel/babel) to the build pipeline if those browser need to be supported.