Skip to content

Commit 88e9812

Browse files
committed
Updated docs
1 parent 2587e9c commit 88e9812

File tree

6 files changed

+63
-21
lines changed

6 files changed

+63
-21
lines changed

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
*.swp
2+
*.swo
23
*~
34
*.log
45
node_modules
6+
*.env
7+
.DS_Store
8+
package-lock.json
9+
.bloggify/*

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ Contributions are more than welcome!
5959

6060
Thanks! :sweat_smile:
6161

62+
63+
6264
[1]: https://github.com/BibleJS/BibleApp/issues
6365

64-
[2]: https://github.com/IonicaBizau/code-style
66+
[2]: https://github.com/IonicaBizau/code-style

LICENSE

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
The MIT License (MIT)
1+
The KINDLY License
2+
Copyright (c) 2014-20 Ionică Bizău <[email protected]>
23

3-
Copyright (c) 2014-15 Ionică Bizău
4+
You have the permission to use this software, read its source code, modify and
5+
redistribute it under the following terms:
46

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
7+
- if you want to use this software or include parts of its code in a
8+
closed-source or commercial project you should kindly ask the
9+
author (via a private message or email) and get a positive answer
10+
- this license should be included in the modified versions of this software
11+
- in case of redistributing modified copies, you are encouraged to clearly
12+
indicate that the copies are based on this work
13+
- if you think that your redistributed copy is awesome, you are encouraged to
14+
show the author of this software what you did and how you helped the others
1115

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
16+
You are free to install and use this software on as many machines as you want,
17+
free of charge, making sure you met the terms above.
1418

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
19+
You are encouraged to kindly support the software and its author by:
20+
21+
- sharing his/her work
22+
- reporting issues/bugs and asking for feature requests
23+
- donating money or any other things that can help the author
24+
- contribute on the software code by fixing bugs and adding features

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,37 @@
1313
<!-- * * * Thanks! * * * -->
1414
<!---------------------------------------------------------------------------->
1515

16+
17+
18+
19+
20+
21+
22+
23+
24+
25+
26+
27+
28+
29+
30+
31+
32+
33+
1634
# `$ bible` [![Donate now][donate-now]][paypal-donations]
1735

1836
Read the Holy Bible via the command line.
1937

38+
2039
![bible](http://i.imgur.com/CcEXgHy.png)
2140

41+
42+
2243
## Installation
2344

45+
46+
2447
You can install the package globally and use it as command line tool:
2548

2649
```sh
@@ -74,9 +97,15 @@ field). The additional configuration fields are listed below:
7497
- `searchLimit`: an integer representing max number of verses that will be
7598
output when searching something
7699
100+
77101
Documentation can be found at https://github.com/BibleJS/BibleApp
78102
```
79103
104+
105+
106+
107+
108+
80109
## First run
81110
Like documented above, on the first run the application will sync the submodules
82111
creating the configuration file (`~/.bible-config.json`) and downloading the
@@ -199,16 +228,19 @@ Results for search: /meroza/i
199228
└───────────────┴───────────────────────────────────────────────────────────────────────────────┘
200229
```
201230
231+
202232
## How to contribute
203233
Have an idea? Found a bug? See [how to contribute][contributing].
204234
235+
205236
## License
206237
[KINDLY][license] © [Ionică Bizău][website]–The [LICENSE](/LICENSE) file contains
207238
a copy of the license.
208239
240+
209241
[license]: http://ionicabizau.github.io/kindly-license/?author=Ionic%C4%83%20Biz%C4%83u%20%[email protected]%3E&year=2015
210242
[contributing]: /CONTRIBUTING.md
211243
[website]: http://ionicabizau.net
212244
[docs]: /DOCUMENTATION.md
213245
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MG98D7NPFZ3MG
214-
[donate-now]: http://i.imgur.com/6cMbHOC.png
246+
[donate-now]: http://i.imgur.com/6cMbHOC.png

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
"blah": {
4646
"ex_img": "http://i.imgur.com/CcEXgHy.png"
4747
}
48-
}
48+
}

0 commit comments

Comments
 (0)