Merge branch 'hotfix/add-docs'

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+### Subject of the issue
+Describe your issue here.
+
+### Your environment
+* version of simple-angular-jwt-auth:
+* version of angular:
+* which browser and its version:
+
+### Steps to reproduce
+Tell us how to reproduce this issue. Please provide a working demo, you can use [this template](https://embed.plnkr.co/8vAHAkbADHA48q56bfiE?p=preview) as a base to create a plunk or you can provide a sample repository.
+
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+## Description
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+Fixes # (issue)
+
+## Type of change
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+- [ ] Test A
+- [ ] Test B
+
+**Test Configuration**:
+* Firmware version:
+* Hardware:
+* Toolchain:
+* SDK:
+
+## Checklist:
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules

.travis.yml

@@ -12,6 +12,7 @@ deploy:
   email: [email protected]
   skip_cleanup: true
   on:
+    tags: true
     branch: master
   api_key:
     secure: iEqsj9XjqocVrVbASBC+xdq2O6pHhNBZRpwT7C88iLp42izyW0rYp6/BTeqXlf7Rdv8Uf2sqQ/4yRI9vhAQOCc7rwutfCMABpo1cQv2THGRIEDmgkHqS8CEobhi+7HE6r/oL3ae37QuAzRP4qFJWABH1al2DQObcnoaN2IxkmmybGq4u8opjPHp1bfiBlUAV98EXwvHaF+IKl3QE3KUL9DdZD6ok+29x/WFxkHz4j8YJ/Orykgqegg/ApeFXmaoSMsslbho41HD29Xg7KIu/lh1SywxaaFZdVWY3NWYnrArLwVntG4L5wv5/sLt5gqGKMNDnA2QeJ4J6LKgfKAFg8+nyOFt+qji3fnhHGvab9WSGzG47FF64ilCVxgehHQhyMPxa+wjzfYGdRghFGe8+rXZV0tAEqWkaMgTP1llhMh6zKBNsrgGkcJthIHQxc69F8W4PuBT6Oauoh/EsP3VKIrUXakt7JyqlCfSwR+mIDkcLUDOwwGf5vdQ49I5pdf27W2V/qSwV/xrCodjiYrhBY60suSnnaR/79Fxy5G29fKhemMxTwKtlWvWYlDdpijoW2b+jRzmNbL+l4Y3L1jDS+D7OgnTO5HaRtezxRCRHfPUdufV8ZNDHR+vyKdKAhDSKTVUcvJ6Ll5AvREPHyEHJ022pahwC010QDklraWx4u6M=

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+## Issue Process
+
+1. Attach a plunk of sample repository that we can use to reproduce the error.
+2. Clearly describe the expected behaviour, actual behaviour and environment when submitting.
+2. Use the template when submitting issues.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new providers 
+   variables, modules, configurations.
+3. Increase the version numbers in package.json files to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. Use the template provided when submitting pull requests.
+5. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.

LICENCE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2017 Randil Fernando
+
+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

@@ -5,6 +5,8 @@
 Simple-angular-jwt-auth is a library that can be used to implement authentication workflow of your angular 5+ application.
 This library uses HttpClient to send http requests.
 
+Click [here](https://embed.plnkr.co/qstWVYDhzfY4L4YF5Pxp?p=preview) to find a working demo.
+
 ## Add library to your project
 
 ```bash
@@ -331,5 +333,6 @@ This will return the permissions object inside PermissionsProvider and you can u
 
 ## Help
 
-Repository: [https://github.com/randilfernando/simple-angular-jwt-auth](https://github.com/randilfernando/simple-angular-jwt-auth)
-Issues: [https://github.com/randilfernando/simple-angular-jwt-auth/issues](https://github.com/randilfernando/simple-angular-jwt-auth/issues)
+Repository: [https://github.com/randilfernando/simple-angular-jwt-auth](https://github.com/randilfernando/simple-angular-jwt-auth)  
+Issues: [https://github.com/randilfernando/simple-angular-jwt-auth/issues](https://github.com/randilfernando/simple-angular-jwt-auth/issues)  
+Demo: [https://embed.plnkr.co/qstWVYDhzfY4L4YF5Pxp?p=preview](https://embed.plnkr.co/qstWVYDhzfY4L4YF5Pxp?p=preview)