Skip to content

Commit 38b220e

Browse files
committed
Improve README content + spelling
1 parent c54ac6f commit 38b220e

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
# Share API Polyfill
22

3-
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.
3+
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.
44

5-
It also supports multilanguage ([see the list of languages](#multi-language) and you can help us with that :) ).
5+
It also supports multi-language ([see the list of languages](#multi-language) - and you can help us with that :) ).
66

7-
This is a very simple, single file import polyfill.
7+
This is a single file import polyfill.
88

99
![JavaScript Share API Polyfill in a Browser](https://github.com/on2-dev/share-api-polyfill/blob/master/demo/demo.gif?raw=true)
10-
[see the share api polyfill in action](https://on2-dev.github.io/share-api-polyfill/demo/)
10+
[see the Share API Polyfill in action](https://on2-dev.github.io/share-api-polyfill/demo/)
1111

1212
## Installing it:
1313

14-
Just import it like so:
14+
Import it like so:
1515

1616
```html
1717
<script src="https://unpkg.com/share-api-polyfill/dist/share-min.js"></script>
1818
```
1919

20-
> 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.
20+
> 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.
2121
2222
You can also install it using npm:
2323

@@ -27,13 +27,13 @@ npm install share-api-polyfill --save
2727
yarn add share-api-polyfill
2828
```
2929

30-
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.
30+
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.
3131

3232
Here, check this demo and see the [share api polyfill in action](https://on2-dev.github.io/share-api-polyfill/demo/).
3333

3434
## The Share API
3535

36-
The oficial share api works like this:
36+
The official Share Api works like this:
3737

3838
```js
3939
navigator.share({
@@ -46,7 +46,7 @@ navigator.share({
4646
```
4747

4848
But in this case, you can also pass your `Facebook App Id` to enable sharing with **messenger**.
49-
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.
49+
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.
5050

5151
```js
5252
navigator.share({
@@ -62,12 +62,12 @@ navigator.share({
6262
.catch( error => console.log('Oh noh! You couldn\'t share it! :\'(\n', error));
6363
```
6464

65-
> You can pass the hashtags as a single (comma separated) string, or as an array.
65+
> You can pass the hashtags as a single (comma-separated) string or as an array.
6666
67-
### Multi language
67+
### Multi-language
6868

69-
It will try and use the supported languages based on user's `browser language` configuration.
70-
If the language is not found, it will uses a fallback (default english).
69+
It will try and use the supported languages based on the user's `browser language` configuration.
70+
If the language is not found, it will use a fallback (default English).
7171

7272
Currently supported languages:
7373

@@ -92,11 +92,11 @@ Currently supported languages:
9292
- tr
9393
- zh
9494

95-
> Feel free to contribute with more languages sending Pull Requests for them :)
95+
> Feel free to contribute with more languages by sending Pull Requests for them :)
9696
97-
### Turning features off, in Desktop
97+
### Turning features off - on Desktop
9898

99-
You can disable some of the social buttons from the tool by passing a second object as argument.
99+
You can disable some of the social buttons from the tool by passing a second object as the argument.
100100
As your mobile device will probably have native support for the share API, it will be ignored, being applied only for desktops.
101101

102102
Example:
@@ -111,7 +111,7 @@ navigator.share({
111111
hashtags: 'javascript,shareAPI,polyfill'
112112
},
113113
{
114-
// change this configurations to hide specific unnecessary icons
114+
// change these configurations to hide specific unnecessary icons
115115
copy: true,
116116
email: true,
117117
print: true,
@@ -131,34 +131,34 @@ navigator.share({
131131
.catch( error => console.log('Oh noh! You couldn\'t share it! :\'(\n', error));
132132
```
133133

134-
> 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**.
134+
> 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**.
135135
136136
## It's open source
137137

138-
Yup, it's open source and you can contribute to it :)
138+
Yup, it's open source, and you can contribute to it! :)
139139

140140
Please refer to our [CONTRIBUTING.md](https://github.com/on2-dev/share-api-polyfill/blob/master/CONTRIBUTING.md) and help us improve this tool.
141141

142-
To re-build id, just install the dependencies:
142+
To build it locally, install the dependencies:
143143

144144
```sh
145145
npm install
146146
```
147147

148-
And build it with gulp
148+
Build it with gulp:
149149

150150
```sh
151151
npm run build
152152
```
153153

154-
And try it locally
154+
And try it locally:
155155

156156
```sh
157157
npm run demo
158158
```
159159

160160
Also, if you need to change the icons, they are SVGs located on the share.js script.
161-
You will find the oridinal vector (.svg) in the src/icons directory in case you want to change it and copy the svg code.
161+
You will find the original vector (.svg) in the src/icons directory in case you want to change it and copy the SVG code.
162162

163163
## Donate ❤️
164164

0 commit comments

Comments
 (0)