Skip to content

Commit 2bd3640

Browse files
authored
Fix capitalization and typo in README
1 parent e4176d1 commit 2bd3640

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
@@ -53,7 +53,7 @@ The widget will automatically attach itself to the window object as
5353
You can use this global object like this:
5454

5555
```js
56-
// open the modal
56+
// Open the modal
5757
netlifyIdentity.open();
5858

5959
// Get the current user:
@@ -70,7 +70,7 @@ netlifyIdentity.on("close", () => console.log("Widget closed"));
7070
// Close the modal
7171
netlifyIdentity.close();
7272

73-
// Logout the user
73+
// Log out the user
7474
netlifyIdentity.logout();
7575
```
7676

@@ -82,7 +82,7 @@ and will only reflect breaking changes in the markup API.
8282
### Module API
8383

8484
Netlify Identity Widget also has a
85-
[module api](https://www.npmjs.com/package/netlify-identity-widget):
85+
[module API](https://www.npmjs.com/package/netlify-identity-widget):
8686

8787
```
8888
yarn add netlify-identity-widget
@@ -111,19 +111,19 @@ netlifyIdentity.on("close", () => console.log("Widget closed"));
111111
// Close the modal
112112
netlifyIdentity.close();
113113

114-
// Logout the user
114+
// Log out the user
115115
netlifyIdentity.logout();
116116

117-
// Access the underlying gotrue instance.
118-
// Note that doing things directly through gotrue brings a risk of getting out of
119-
// sync between your state and the widgets state.
117+
// Access the underlying GoTrue JS client.
118+
// Note that doing things directly through the GoTrue client brings a risk of getting out of
119+
// sync between your state and the widget’s state.
120120
netlifyIdentity.gotrue;
121121
```
122122

123123
#### `netlifyIdentity.init([opts])`
124124

125125
You can pass an optional `opts` object to configure the widget when using the
126-
module api. Options include:
126+
module API. Options include:
127127

128128
```js
129129
{

0 commit comments

Comments
 (0)