Updated docs

.gitignore

@@ -3,3 +3,7 @@
 *~
 *.log
 node_modules
+*.env
+.DS_Store
+package-lock.json
+.bloggify/*

DOCUMENTATION.md

@@ -6,6 +6,7 @@ You can see below the API reference of this module.
 Creates a new instance of `ElasticFire`.
 
 #### Params
+
 - **Object** `config`: An object containing the following fields:
    - paths (Array): An array of objects to configure the way how the
      data is taken from Firebase:

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-16 Bloggify <[email protected]> (https://bloggify.org)
+Copyright (c) 2013-20 Bloggify <[email protected]> (https://bloggify.org)
 
 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,27 +1,83 @@
+<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
+
+
+
+
+
+
+
 
 [![elasticfire](https://i.imgur.com/WnGtDhC.png)](#)
 
+
+
+
+
+
+
+
+
+
+
 # elasticfire
 
  [![Version](https://img.shields.io/npm/v/elasticfire.svg)](https://www.npmjs.com/package/elasticfire) [![Downloads](https://img.shields.io/npm/dt/elasticfire.svg)](https://www.npmjs.com/package/elasticfire)
 
+
+
+
+
+
+
 > A flexibe and configurable module to connect Firebase with Elasticsearch.
 
+
+
+
+
+
 ## :rocket: Features
 
+
  - Easily configure the way how the data should be taken from Firebase
  - Filter out documents
  - Include and exclude specific fields
  - Support for joins
 
 
+
+
+
+
+
+
+
+
+
+
+
 ## :cloud: Installation
 
 ```sh
-$ npm i --save elasticfire
+# Using npm
+npm install --save elasticfire
+
+# Using yarn
+yarn add elasticfire
 ```
 
 
+
+
+
+
+
+
+
+
+
+
+
 ## :clipboard: Example
 
 
@@ -87,13 +143,37 @@ ef.on("error", err => {
 });
 ```
 
+
+
+
+
+
+
+
+
+
+
+## :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
 
 
 ### `ElasticFire(config)`
 Creates a new instance of `ElasticFire`.
 
 #### Params
+
 - **Object** `config`: An object containing the following fields:
    - paths (Array): An array of objects to configure the way how the
      data is taken from Firebase:
@@ -129,18 +209,56 @@ Triggers the search in Elasticsearch.
 
 
 
+
+
+
+
+
+
+
+
+
+
+
 ## :yum: How to contribute
 Have an idea? Found a bug? See [how to contribute][contributing].
 
+
+
+
+
+
+
+
+
 ## :cake: Thanks
 [`flashlight`](https://github.com/firebase/flashlight) was the main inspiration for this project. :cake:
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 ## :scroll: License
 
 [MIT][license] © [Bloggify][website]
 
-[license]: http://showalicense.com/?fullname=Bloggify%20%3Csupport%40bloggify.org%3E%20(https%3A%2F%2Fbloggify.org)&year=2013#license-mit
+
+
+
+
+
+[license]: /LICENSE
 [website]: https://bloggify.org
 [contributing]: /CONTRIBUTING.md
 [docs]: /DOCUMENTATION.md

package.json

@@ -54,4 +54,4 @@
     "thanks": "[`flashlight`](https://github.com/firebase/flashlight) was the main inspiration for this project. :cake:"
   },
   "author": "Bloggify <[email protected]> (https://bloggify.org)"
-}
+}