Merge pull request #133 from on2-dev/readme_sp

Improve README content + spelling

Author: felipenmoura

README.md

@@ -1,23 +1,23 @@
 # Share API Polyfill
 
-This is a (6kb) polyfill for the `Web Share API` that can be used in desktop too, so your users can share in their twitter, facebook, messenger, linkedin, sms, e-mail, print, telegram or whatsapp.
+This is a (6kb) polyfill for the `Web Share API` that can be used on desktop, too, so your users can share in their Twitter, Facebook, Messenger, LinkedIn, SMS, email, print, Telegram or WhatsApp.
 
-It also supports multilanguage ([see the list of languages](#multi-language) and you can help us with that :) ).
+It also supports multi-language ([see the list of languages](#multi-language) - and you can help us with that :) ).
 
-This is a very simple, single file import polyfill.
+This is a single file import polyfill which relies on the `navigator.share()` method of the [Web Share API](https://www.w3.org/TR/web-share/).
 
 ![JavaScript Share API Polyfill in a Browser](https://github.com/on2-dev/share-api-polyfill/blob/master/demo/demo.gif?raw=true)  
-[see the share api polyfill in action](https://on2-dev.github.io/share-api-polyfill/demo/)
+[see the Share API Polyfill in action](https://on2-dev.github.io/share-api-polyfill/demo/)
 
 ## Installing it:
 
-Just import it like so:
+Import it like so:
 
 ```html
 <script src="https://unpkg.com/share-api-polyfill/dist/share-min.js"></script>
 ```
 
-> Note that we are using the unpkg cdn to load it, you could also save it in your own structure so you can cache it with service workers and have it "close" to your own domain.
+> Note that we are using the unpkg CDN to load it. You could also save it in your own structure so you can cache it with service workers and have it "close" to your own domain.
 
 You can also install it using npm:
 
@@ -27,13 +27,13 @@ npm install share-api-polyfill --save
 yarn add share-api-polyfill
 ```
 
-Now, it will use the native share panel if it is available (only available on mobile devices) and, if not, it will enable an HTML structure in your page showing options for your users.
+Now, it will use the native share panel if it is available (only available on mobile devices), and if not, it will enable an HTML structure on your page showing options for your users.
 
 Here, check this demo and see the [share api polyfill in action](https://on2-dev.github.io/share-api-polyfill/demo/).
 
 ## The Share API
 
-The oficial share api works like this:
+The official Share Api works like this:
 
 ```js
 navigator.share({
@@ -46,7 +46,7 @@ navigator.share({
 ```
 
 But in this case, you can also pass your `Facebook App Id` to enable sharing with **messenger**.
-Also, you can pass in a list of hashtags to be used when sharing with twitter or facebook. Only one hashtag can be shared with facebook so the first one in the list will be shared.
+Also, you can pass in a list of hashtags to be used when sharing on Twitter or Facebook. Only one hashtag can be shared on Facebook, so the first one on the list will be shared.
 
 ```js
 navigator.share({
@@ -62,22 +62,24 @@ navigator.share({
 .catch( error => console.log('Oh noh! You couldn\'t share it! :\'(\n', error));
 ```
 
-> You can pass the hashtags as a single (comma separated) string, or as an array.
+> You can pass the hashtags as a single (comma-separated) string or as an array.
 
-### Multi language
+### Multi-language
 
-It will try and use the supported languages based on user's `browser language` configuration.  
-If the language is not found, it will uses a fallback (default english).
+It will try and use the supported languages based on the user's `browser language` configuration.  
+If the language is not found, it will use a fallback (default English).
 
 Currently supported languages:
 
+- bn
 - cs
 - de
 - it
 - da
 - en
 - es
 - fr
+- hi
 - hu
 - is
 - ja
@@ -92,11 +94,11 @@ Currently supported languages:
 - tr
 - zh
 
-> Feel free to contribute with more languages sending Pull Requests for them :)
+> Feel free to contribute with more languages by sending Pull Requests for them :)
 
-### Turning features off, in Desktop
+### Turning features off - on Desktop
 
-You can disable some of the social buttons from the tool by passing a second object as argument.  
+You can disable some of the social buttons from the tool by passing a second object as the argument.  
 As your mobile device will probably have native support for the share API, it will be ignored, being applied only for desktops.
 
 Example:
@@ -111,7 +113,7 @@ navigator.share({
     hashtags: 'javascript,shareAPI,polyfill'
   },
   {
-    // change this configurations to hide specific unnecessary icons
+    // change these configurations to hide specific unnecessary icons
     copy: true,
     email: true,
     print: true,
@@ -131,34 +133,34 @@ navigator.share({
   .catch( error => console.log('Oh noh! You couldn\'t share it! :\'(\n', error));
 ```
 
-  > If you disable Skype, it will no longer load Skype's SDK, what might be something you want, in case you would like to improve the privacy in your project, avoiding loading **third party libraries**.
+  > If you disable Skype, it will no longer load Skype's SDK, which might be something you want, in case you would like to improve the privacy in your project, avoiding loading **third-party libraries**.
 
 ## It's open source
 
-Yup, it's open source and you can contribute to it :)
+Yup, it's open source, and you can contribute to it! :)
 
 Please refer to our [CONTRIBUTING.md](https://github.com/on2-dev/share-api-polyfill/blob/master/CONTRIBUTING.md) and help us improve this tool.
 
-To re-build id, just install the dependencies:
+To build it locally, install the dependencies:
 
 ```sh
 npm install
 ```
 
-And build it with gulp
+Build it with gulp:
 
 ```sh
 npm run build
 ```
 
-And try it locally
+And try it locally:
 
 ```sh
 npm run demo
 ```
 
 Also, if you need to change the icons, they are SVGs located on the share.js script.
-You will find the oridinal vector (.svg) in the src/icons directory in case you want to change it and copy the svg code.
+You will find the original vector (.svg) in the src/icons directory in case you want to change it and copy the SVG code.
 
 ## Donate ❤️