-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
677428b
commit e7df6f7
Showing
5 changed files
with
43 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,8 +10,8 @@ | |
|
||
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 | ||
|
||
|
@@ -21,11 +21,13 @@ Login via the demo credentials `[email protected]` / `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` | ||
|
@@ -84,13 +86,26 @@ Old version of the ICE is not available since version 2.0.0. If you still would | |
#### 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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters