Skip to content

Commit 6131394

Browse files
committed
Updated docs
1 parent 4d9d3e3 commit 6131394

3 files changed

Lines changed: 110 additions & 11 deletions

File tree

README.md

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

33

4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
420
# bible-english
521

6-
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/bible-english.svg)](https://www.npmjs.com/package/bible-english) [![Downloads](https://img.shields.io/npm/dt/bible-english.svg)](https://www.npmjs.com/package/bible-english)
22+
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/bible-english.svg)](https://www.npmjs.com/package/bible-english) [![Downloads](https://img.shields.io/npm/dt/bible-english.svg)](https://www.npmjs.com/package/bible-english) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
23+
24+
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
25+
26+
27+
28+
29+
30+
731

832
> NodeJS wrapper for labs.bible.org API.
933
34+
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+
45+
46+
47+
48+
49+
1050
## :cloud: Installation
1151

1252
```sh
@@ -18,6 +58,17 @@ yarn add bible-english
1858
```
1959

2060

61+
62+
63+
64+
65+
66+
67+
68+
69+
70+
71+
2172
## :clipboard: Example
2273

2374

@@ -42,18 +93,26 @@ bible.getVerse("John 1:1", (err, data) => {
4293

4394

4495

96+
97+
98+
99+
100+
101+
45102
## :question: Get Help
46103

47104
There are few ways to get help:
48105

106+
107+
49108
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.
50109
2. For bug reports and feature requests, open issues. :bug:
51-
52110
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
53111

54112

55113

56114

115+
57116
## :memo: Documentation
58117

59118

@@ -70,12 +129,22 @@ Gets the reference using labs.bible.org provider.
70129

71130

72131

132+
133+
134+
135+
136+
137+
138+
139+
140+
141+
142+
73143
## :yum: How to contribute
74144
Have an idea? Found a bug? See [how to contribute][contributing].
75145

76146

77147
## :sparkling_heart: Support my projects
78-
79148
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
80149
this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
81150

@@ -95,21 +164,51 @@ Thanks! :heart:
95164

96165

97166

167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
180+
## :dizzy: Where is this library used?
181+
If you are using this library in one of your projects, add it in this list. :sparkles:
182+
183+
- `bibletext.co`
184+
185+
186+
187+
188+
189+
190+
191+
192+
193+
194+
98195
## :scroll: License
99196

100197
[MIT][license] © [Ionică Bizău][website]
101198

102199

200+
201+
202+
203+
204+
[license]: /LICENSE
205+
[website]: https://ionicabizau.net
206+
[contributing]: /CONTRIBUTING.md
207+
[docs]: /DOCUMENTATION.md
103208
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
104209
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
105210
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
106211
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
107-
108212
[patreon]: https://www.patreon.com/ionicabizau
109213
[amazon]: http://amzn.eu/hRo9sIZ
110214
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
111-
112-
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2014#license-mit
113-
[website]: https://ionicabizau.net
114-
[contributing]: /CONTRIBUTING.md
115-
[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
@@ -45,4 +45,4 @@
4545
"bloggify.json",
4646
"bloggify/"
4747
]
48-
}
48+
}

0 commit comments

Comments
 (0)