Updated docs

.gitignore

@@ -2,4 +2,8 @@
 *.swo
 *~
 *.log
-node_modules
+node_modules
+*.env
+.DS_Store
+package-lock.json
+.bloggify/*

CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# :eight_spoked_asterisk: :stars: :sparkles: :dizzy: :star2: :star2: :sparkles: :dizzy: :star2: :star2: Contributing :star: :star2: :dizzy: :sparkles:  :star: :star2: :dizzy: :sparkles: :stars: :eight_spoked_asterisk:
+
+So, you want to contribute to this project! That's awesome. However, before
+doing so, please read the following simple steps how to contribute. This will
+make the life easier and will avoid wasting time on things which are not
+requested. :sparkles:
+
+## Discuss the changes before doing them
+ - First of all, open an issue in the repository, using the [bug tracker][1],
+   describing the contribution you would like to make, the bug you found or any
+   other ideas you have. This will help us to get you started on the right
+   foot.
+
+ - If it makes sense, add the platform and software information (e.g. operating
+   system, Node.JS version etc.), screenshots (so we can see what you are
+   seeing).
+
+ - It is recommended to wait for feedback before continuing to next steps.
+   However, if the issue is clear (e.g. a typo) and the fix is simple, you can
+   continue and fix it.
+
+## Fixing issues
+ - Fork the project in your account and create a branch with your fix:
+   `some-great-feature` or `some-issue-fix`.
+
+ - Commit your changes in that branch, writing the code following the
+   [code style][2]. If the project contains tests (generally, the `test`
+   directory), you are encouraged to add a test as well. :memo:
+
+ - If the project contains a `package.json` or a `bower.json` file add yourself
+   in the `contributors` array (or `authors` in the case of `bower.json`;
+   if the array does not exist, create it):
+
+   ```json
+   {
+      "contributors": [
+         "Your Name <and@email.address> (http://your.website)"
+      ]
+   }
+   ```
+
+## Creating a pull request
+
+ - Open a pull request, and reference the initial issue in the pull request
+   message (e.g. *fixes #<your-issue-number>*). Write a good description and
+   title, so everybody will know what is fixed/improved.
+
+ - If it makes sense, add screenshots, gifs etc., so it is easier to see what
+   is going on.
+
+## Wait for feedback
+Before accepting your contributions, we will review them. You may get feedback
+about what should be fixed in your modified code. If so, just keep committing
+in your branch and the pull request will be updated automatically.
+
+## Everyone is happy!
+Finally, your contributions will be merged, and everyone will be happy! :smile:
+Contributions are more than welcome!
+
+Thanks! :sweat_smile:
+
+
+
+[1]: https://github.com/BibleJS/bible-portuguese/issues
+
+[2]: https://github.com/IonicaBizau/code-style

DOCUMENTATION.md

@@ -0,0 +1,15 @@
+## Documentation
+
+You can see below the API reference of this module.
+
+### `getVerse(reference, callback)`
+Gets the reference using labs.bible.org provider.
+
+#### Params
+
+- **String** `reference`: Bible verse reference
+- **Function** `callback`: The callback function
+
+#### Return
+- ****
+

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Raphael Amorim
+Copyright (c) 2015-20 Raphael Amorim
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,39 +1,157 @@
-# Bible Portuguese
-Portuguese Bible module
+<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
 
-## Installation
-Run the following commands to download and install the application:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+# bible-portuguese
+
+ [![Version](https://img.shields.io/npm/v/bible-portuguese.svg)](https://www.npmjs.com/package/bible-portuguese) [![Downloads](https://img.shields.io/npm/dt/bible-portuguese.svg)](https://www.npmjs.com/package/bible-portuguese)
+
+
+
+
+
+
+
+> Portuguese Bible module
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :cloud: Installation
 
 ```sh
-$ git clone git@github.com:BibleJS/bible-portuguese.git bible-portuguese
-$ cd bible-portuguese
-$ npm install
+# Using npm
+npm install --save bible-portuguese
+
+# Using yarn
+yarn add bible-portuguese
 ```
 
-## Example
 
-```js
-// Dependencies
-var PtBible = require("bible-portuguese");
 
-// Get verse
-PtBible.getVerse("Mateus 1:1", function (err, data) {
-    console.log(err || data);
-});
 
-```
 
-## How to contribute
 
-1. File an issue in the repository, using the bug tracker, describing the
-   contribution you'd like to make. This will help us to get you started on the
-   right foot.
-2. Fork the project in your account and create a new branch:
-   `your-great-feature`.
-3. Write code and tests, and run `npm test` to confirm everything works.
-3. Commit your changes to that branch.
-4. Open a pull request, and reference the initial issue in the pull request
-   message (if solving an issue).
 
-## License
-See the [LICENSE](./LICENSE) file.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :question: Get Help
+
+There are few ways to get help:
+
+
+
+ 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.
+ 2. For bug reports and feature requests, open issues. :bug:
+
+
+
+
+
+## :memo: Documentation
+
+
+### `getVerse(reference, callback)`
+Gets the reference using labs.bible.org provider.
+
+#### Params
+
+- **String** `reference`: Bible verse reference
+- **Function** `callback`: The callback function
+
+#### Return
+- ****
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :yum: How to contribute
+Have an idea? Found a bug? See [how to contribute][contributing].
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :scroll: License
+
+[MIT][license] © [Raphael Amorim][website]
+
+
+
+
+
+
+[license]: /LICENSE
+[website]: undefined
+[contributing]: /CONTRIBUTING.md
+[docs]: /DOCUMENTATION.md

package.json

@@ -27,4 +27,4 @@
   "devDependencies": {
     "prova": "^3.0.0"
   }
-}
+}