Skip to content

Commit 409e1b7

Browse files
committed
Updated docs
1 parent d223875 commit 409e1b7

File tree

5 files changed

+112
-14
lines changed

5 files changed

+112
-14
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ node_modules
66
*.env
77
.DS_Store
88
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) 2014-19 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
3+
Copyright (c) 2014-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
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: 108 additions & 11 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.js
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.js.svg)](https://www.npmjs.com/package/bible.js) [![Downloads](https://img.shields.io/npm/dt/bible.js.svg)](https://www.npmjs.com/package/bible.js)
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.js.svg)](https://www.npmjs.com/package/bible.js) [![Downloads](https://img.shields.io/npm/dt/bible.js.svg)](https://www.npmjs.com/package/bible.js) [![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
> The Bible as a NPM module.
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.js
1858
```
1959

2060

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

2374

@@ -72,17 +123,28 @@ Bible.init({
72123

73124

74125

126+
127+
128+
129+
130+
131+
132+
133+
75134
## :question: Get Help
76135

77136
There are few ways to get help:
78137

138+
139+
79140
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.
80141
2. For bug reports and feature requests, open issues. :bug:
81-
82142
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
83143

84144

85145

146+
147+
86148
## :memo: Documentation
87149

88150

@@ -145,12 +207,22 @@ provided.
145207

146208

147209

210+
211+
212+
213+
214+
215+
216+
217+
218+
219+
220+
148221
## :yum: How to contribute
149222
Have an idea? Found a bug? See [how to contribute][contributing].
150223

151224

152225
## :sparkling_heart: Support my projects
153-
154226
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
155227
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).
156228

@@ -169,28 +241,53 @@ However, if you get some profit from this or just want to encourage me to contin
169241
Thanks! :heart:
170242

171243

244+
245+
246+
247+
248+
249+
250+
251+
252+
253+
254+
255+
256+
257+
172258
## :dizzy: Where is this library used?
173259
If you are using this library in one of your projects, add it in this list. :sparkles:
174260

261+
- `bible-sample-config`
262+
- `bible`
263+
264+
265+
266+
267+
268+
269+
270+
271+
175272

176-
- [`bible`](https://github.com/BibleJS/BibleApp)—Read the Holy Bible via the command line.
177-
- [`bible-sample-config`](https://github.com/BibleJS/sample-config)—Sample configuration for Bible CLI client.
178273

179274
## :scroll: License
180275

181276
[MIT][license] © [Ionică Bizău][website]
182277

183278

279+
280+
281+
282+
283+
[license]: /LICENSE
284+
[website]: https://ionicabizau.net
285+
[contributing]: /CONTRIBUTING.md
286+
[docs]: /DOCUMENTATION.md
184287
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
185288
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
186289
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
187290
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
188-
189291
[patreon]: https://www.patreon.com/ionicabizau
190292
[amazon]: http://amzn.eu/hRo9sIZ
191293
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
192-
193-
[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
194-
[website]: https://ionicabizau.net
195-
[contributing]: /CONTRIBUTING.md
196-
[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
@@ -52,4 +52,4 @@
5252
"bloggify.json",
5353
"bloggify/"
5454
]
55-
}
55+
}

0 commit comments

Comments
 (0)