Add:

- License;
- Contribuing;
Update Readme

Author: fernandocode

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+Have you found a bug, or want to develop a new feature?
+
+1. [Look for Pull Requests](https://github.com/fernandocode/database-builder/pulls) if something is not already implemented;
+2. [Check if there is no Issue related to this](https://github.com/fernandocode/database-builder/issues)? (If there is not one, so that the use case can be checked);
+3. Make the necessary changes, add tests to what has been implemented, run the tests and submit a Pull Request with the changes (Comment what was done, and relate the Issue). As soon as possible it will be verified, and if approved it will be available in the next release of the library.

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Fernando Leal
+
+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

@@ -1,7 +1,8 @@
 [![npm version](https://badge.fury.io/js/database-builder.svg/?a=1)](https://www.npmjs.com/package/database-builder)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/fernandocode/database-builder/issues)
 
 # database-builder
-Framework to assist in database manipulation (DDL and CRUD)
+Library to assist in creating and maintaining SQL commands.
 
 [look at the test for more details of use (`./src/test/`)](https://github.com/fernandocode/database-builder/tree/master/src/test)
 
@@ -142,4 +143,30 @@ export class AppComponent {
 
 ### Usage Ionic 2+
 
-[*Demo*](https://stackblitz.com/edit/ionic-6sdjng)
+[*Demo*](https://stackblitz.com/edit/ionic-6sdjng)
+
+
+# Contribution Welcome!
+
+The project is continously evolving with every new release. Give it a star, if you like it. For contribution, setup the development environment as follows:
+
+1. clone and setup the project dependencies
+
+```shell
+$> git clone https://github.com/fernandocode/database-builder.git
+$> npm install
+```
+
+2. Use following commands based on what you'd like to do:
+
+```shell
+$> npm test              # runs test suite once and exit.
+```
+
+3. Have you found a bug, or want to develop a new feature?
+
+3.1. [Look for Pull Requests](https://github.com/fernandocode/database-builder/pulls) if something is not already implemented;
+3.2. [Check if there is no Issue related to this](https://github.com/fernandocode/database-builder/issues)? (If there is not one, so that the use case can be checked);
+3.3. Make the necessary changes, add tests to what has been implemented, run the tests and submit a Pull Request with the changes (Comment what was done, and relate the Issue). As soon as possible it will be verified, and if approved it will be available in the next release of the library.
+
+If you face any problem, then raise an issue [here](https://github.com/fernandocode/database-builder/issues).

tslint.json

@@ -16,8 +16,10 @@
             true,
             "ban-keywords",
             "check-format",
-            "allow-leading-underscore"
+            "allow-leading-underscore",
+            "allow-pascal-case"
         ],
+        "no-shadowed-variable": false,
         "interface-name": [
             true,
             "never-prefix"