Skip to content

Commit 5a07880

Browse files
committed
Updated docs
1 parent 5fb0a09 commit 5a07880

2 files changed

Lines changed: 19 additions & 6 deletions

File tree

DOCUMENTATION.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
You can see below the API reference of this module.
44

5-
### Plugin Configuration
5+
### `bloggify:init(config)`
66

7+
#### Params
8+
- **Object** `config`:
79
- `loginURI` (String): The application login url.
810
- `callbackURI`(String): The application login callback url.
911
- `githubClient` (String): The application client id.
@@ -20,11 +22,11 @@ You can see below the API reference of this module.
2022

2123
An error happened durring the error.
2224

23-
- **`login-success`** (`token`, `user`, `lien`, `ghApiClient`);
25+
- **`login-success`** (`token`, `user`, `ctx`, `ghApiClient`)
2426

2527
The user metadata was fetched. If you don't want to fetch
2628

27-
- **`token`** (`token`, `lien`, `ghApiClient`)
29+
- **`token`** (`token`, `ctx`, `ghApiClient`)
2830

2931
Emitted when the token is successfully got.
3032

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,22 @@ GitHub.on("login-success", (token, user, lien) => {
6161
});
6262
```
6363

64+
## :question: Get Help
65+
66+
There are few ways to get help:
67+
68+
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
69+
2. For bug reports and feature requests, open issues. :bug:
70+
3. For direct and quick help from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
71+
72+
6473
## :memo: Documentation
6574

6675

67-
### Plugin Configuration
76+
### `bloggify:init(config)`
6877

78+
#### Params
79+
- **Object** `config`:
6980
- `loginURI` (String): The application login url.
7081
- `callbackURI`(String): The application login callback url.
7182
- `githubClient` (String): The application client id.
@@ -82,11 +93,11 @@ GitHub.on("login-success", (token, user, lien) => {
8293

8394
An error happened durring the error.
8495

85-
- **`login-success`** (`token`, `user`, `lien`, `ghApiClient`);
96+
- **`login-success`** (`token`, `user`, `ctx`, `ghApiClient`)
8697

8798
The user metadata was fetched. If you don't want to fetch
8899

89-
- **`token`** (`token`, `lien`, `ghApiClient`)
100+
- **`token`** (`token`, `ctx`, `ghApiClient`)
90101

91102
Emitted when the token is successfully got.
92103

0 commit comments

Comments
 (0)