Skip to content

Commit ecd2a00

Browse files
authored
Merge pull request #1 from Naahuel/naahuel-doc-patch
Minor doc corrections
2 parents 643854e + 51c44a6 commit ecd2a00

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ npm install draft-js-iframely-plugin
1313

1414
*Optional*
1515
In your index.html include the embed.js provided by Iframely.
16-
In case of omit it, it will be included with thr first embedded URL.
16+
In case of omiting it, it will be included with the first embedded URL.
1717

1818
```html
1919
<script src="//cdn.iframe.ly/embed.js" async></script>
2020
```
2121

2222
## Usage
2323
This plugin embeds URLs in different ways:
24-
1. When press Enter in a block that the text is a URL.
25-
2. When paste a text that is a URL (disabled by default).
24+
1. When pressing Enter in a block where the text is a URL.
25+
2. When pasting a text that is a URL (disabled by default).
2626
3. Intregrating the Embed button with `draft-js-side-toolbar-plugin`.
2727

2828
```js
@@ -36,8 +36,8 @@ const { EmbedButton } = iframelyPlugin;
3636
```
3737

3838
#### Embedder
39-
When integrate the plugin with `draft-js-side-toolbar-plugin` and click the Embed button, it will display a plceholder where you can paste the URL.
40-
Pressing Enter will close and embed the URL; but, losing the focus, pressing ESC or DEL with empty text will close the Embedder.
39+
When integrating the plugin with `draft-js-side-toolbar-plugin` and clicking the Embed button, it will display a plceholder where you can paste the URL.
40+
Pressing Enter will close and embed the URL; but, lose the focus on the editor, pressing ESC or DEL with empty text will close the Embedder.
4141

4242
## Configuration
4343
| Param | Default | Description |
@@ -54,8 +54,8 @@ Pressing Enter will close and embed the URL; but, losing the focus, pressing ESC
5454
|----------------|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
5555
| apiKey | (Required) | Iframely API Key. |
5656
| placehoder | 'Paste a link to embed content and press Enter' | Text as placeholder for the Embedder. |
57-
| handleOnReturn | true | Embed the text when press Enter if it is a URL. |
58-
| handleOnPaste | false | Embed the text pasted if it is a URL. |
57+
| handleOnReturn | true | Embed the text when pressing Enter if it is a URL. |
58+
| handleOnPaste | false | Embed the pasted text if it is a URL. |
5959
| params | ``` { iframe: 1 rel: 'summary', omit_script: true, align: 'center', html5: 1 } ``` | Params to pass in the request. https://iframely.com/docs/parameters |
6060
| onRequest | `return (await fetch(url)).json()` | Function to request the metadata of the URL. It will receive the URL to request and MUST return a JSON, contaning the key 'html'. |
6161

@@ -64,7 +64,7 @@ The plugin ships with a default styling available at this location in the instal
6464

6565
*Webpack Usage*
6666
1. Install Webpack loaders: `npm i style-loader css-loader --save-dev`
67-
2. Add the below section to Webpack config (if your config already has a loaders array, simply add the below loader object to your existing list.
67+
2. Add the below section to Webpack config (if your config already has a loaders array, simply add the below loader object to your existing list).
6868

6969
```js
7070
module.exports = {

0 commit comments

Comments
 (0)