Update documentation & licence

Author: vademo

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 [Unreleased]: https://github.com/digipolisantwerp/authz_module_nodejs/compare/v0.0.4...HEAD
 ## [Unreleased] - yyyy-mm-dd
 
+[0.1.0]: https://github.com/digipolisantwerp/log_module_nodejs/tree/v0.1.0
+## [0.1.0] - 2021-12-17
+
+- Updated documentation for release
 
 [0.0.6]: https://github.com/digipolisantwerp/log_module_nodejs/tree/v0.0.6
 ## [0.0.6] - 2021-12-16

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Digipolis Antwerpen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -19,6 +19,7 @@ Log helper which converts default logs to indexable json log.
    * [Configuration](#configuration)
    * [Logging](#logging)
    * [Running the tests](#running-the-tests)
+   * [Dependencies](#dependencies)
    * [Versioning](#versioning)
    * [Authors](#authors)
    * [License](#license)
@@ -40,12 +41,14 @@ $ yarn add @digipolis/log
 
 ## Configuration
 
-##### Params:
+### Params:
 | Param                       | Description                                | Values                                    |
 | :---                        | :---                                       | :---                                      |
 | ***type*** *(optional)*     | Set logging mode                           | **log** (default) / **json** / **text**   |
 | ***override*** *(optional)* | Set to override given console (default)    | **true** / **false** (default)            |
 
+## Examples
+
 ##### Example:
 ```javascript
 const digipolisLogger = require('@digipolis/log');
@@ -80,9 +83,8 @@ type: 'log' -> {"message":"hello","timestamp":"2021-12-01T09:45:56.515Z","type":
 
 ```
 
-## Logging
 
-#### Examples
+#### output examples
 ```javascript
 
 // type: json
@@ -154,3 +156,39 @@ console.log({ message: 'logmessage2', timestamp: 'timestamp123', extra_param1: "
 */
 ```
 
+
+## Running the tests
+
+Run the tests in this repo:
+
+```bash
+$ npm run test
+$ npm run coverage
+```
+## Dependencies
+
+none.
+
+## Versioning
+
+We use [SemVer](http://semver.org/)
+
+for versioning. For the released version check changelog / tags
+
+## Contributing
+
+Pull requests are always welcome, however keep the following things in mind:
+
+- New features (both breaking and non-breaking) should always be discussed with the [repo's owner](#support). If possible, please open an issue first to discuss what you would like to change.
+- Fork this repo and issue your fix or new feature via a pull request.
+- Please make sure to update tests as appropriate. Also check possible linting errors and update the CHANGELOG if applicable.
+
+## Authors
+
+* Olivier Van den Mooter (<olivier.vandenmooter@digipolis.be>) - Initial work - [Vademo](https://github.com/vademo)
+
+See also the list of [contributors](https://github.com/digipolisantwerp/authz_module_nodejs/graphs/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

package.json

@@ -1,7 +1,13 @@
 {
   "name": "@digipolis/log",
   "version": "0.0.6",
-  "description": "a logging tool for digipolis kibana logging",
+  "keywords": [
+    "digipolis",
+    "antwerpen",
+    "log",
+    "logger"
+  ],
+  "description": "A logging tool for Digipolis kibana logging",
   "main": "lib/index.js",
   "scripts": {
     "start": "nodemon ./example/index.js",
@@ -15,7 +21,7 @@
     "url": "https://github.com/digipolisantwerp/log_module_nodejs.git"
   },
   "author": "Olivier Van den Mooter",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "chai": "^4.3.4",
     "chai-json-schema": "^1.5.1",