Skip to content

Commit 373bd8f

Browse files
committed
Updated docs
1 parent 48f014d commit 373bd8f

5 files changed

Lines changed: 112 additions & 6 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44
*.log
55
node_modules
66
*.env
7+
.DS_Store
8+
package-lock.json
9+
.bloggify/*

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016-17 Bloggify <support@bloggify.org> (https://bloggify.org)
3+
Copyright (c) 2016-20 Bloggify <support@bloggify.org> (https://bloggify.org)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 106 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,72 @@
11
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
22

3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
320
# bloggify-github-login
421

522
[![Version](https://img.shields.io/npm/v/bloggify-github-login.svg)](https://www.npmjs.com/package/bloggify-github-login) [![Downloads](https://img.shields.io/npm/dt/bloggify-github-login.svg)](https://www.npmjs.com/package/bloggify-github-login)
623

24+
25+
26+
27+
28+
29+
730
> Login with GitHub for Bloggify.
831
32+
33+
34+
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+
45+
46+
47+
948
## :cloud: Installation
1049

1150
```sh
12-
$ npm i --save bloggify-github-login
51+
# Using npm
52+
npm install --save bloggify-github-login
53+
54+
# Using yarn
55+
yarn add bloggify-github-login
1356
```
1457

1558

59+
60+
61+
62+
63+
64+
65+
66+
67+
68+
69+
1670
## :clipboard: Example
1771

1872

@@ -64,13 +118,25 @@ GitHub.on("login-success", (token, user, lien) => {
64118

65119

66120

121+
122+
123+
124+
125+
126+
127+
128+
67129
## :question: Get Help
68130

69131
There are few ways to get help:
70132

133+
134+
71135
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.
72136
2. For bug reports and feature requests, open issues. :bug:
73-
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
137+
138+
139+
74140

75141

76142
## :memo: Documentation
@@ -105,16 +171,53 @@ There are few ways to get help:
105171

106172

107173

174+
175+
176+
177+
178+
179+
180+
181+
182+
183+
184+
108185
## :yum: How to contribute
109186
Have an idea? Found a bug? See [how to contribute][contributing].
110187

111188

112189

190+
191+
192+
193+
194+
195+
196+
197+
198+
199+
200+
201+
202+
203+
204+
205+
206+
207+
208+
209+
210+
113211
## :scroll: License
114212

115213
[MIT][license] © [Bloggify][website]
116214

117-
[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2016#license-mit
215+
216+
217+
218+
219+
220+
[license]: /LICENSE
118221
[website]: https://bloggify.org
119222
[contributing]: /CONTRIBUTING.md
120223
[docs]: /DOCUMENTATION.md

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@
4141
"gh.js": "^3.0.6",
4242
"github-oauth": "^0.2.2"
4343
}
44-
}
44+
}

0 commit comments

Comments
 (0)