readme, contributing and code of conduct md files

README.md

@@ -1,2 +1,53 @@
-# tfrs
-Transportation Fuels Reporting System
+# TFRS
+##Transportation Fuels Reporting System
+
+### Usage
+This software is being developed to streamline compliance reporting for transportation fuel suppliers  
+
+#### Data
+The system will have data on the following topics:
+<ul>
+<li>A record of all approved Fuels (and their corresponding Carbon Intensity Records) which are supplied in BC</li>
+<li>A record of a companies that Supply fuel in BC</li>
+<li>A record of all fuel transfers between companies</li>
+<li>A record of all fuels supplied each years</li>
+<li>A record of the Carbon credit balances of fuel suppliers</li>
+<li>A record of all Carbon Credit trades between fuel suppliers</li>
+
+#### Code
+Currently the code consists of html/js/css referencing bootstrap css and js libraries
+https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css
+https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap-theme.min.css
+https://rawgit.com/wenzhixin/bootstrap-table/master/src/bootstrap-table.css
+https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js
+https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js
+https://rawgit.com/wenzhixin/bootstrap-table/master/src/bootstrap-table.js
+
+
+### Project Status
+This project is in development. Current work includes low-fidelity and hi-fidelity mockups.
+
+### Getting Help or Reporting an Issue
+To report bugs/issues/features requests, please file an [issue](https://github.com/bcgov/tfrs/issues/).
+
+### How to Contribute
+If you would like to contribute, please see our [contributing](contributing.md) guidelines.
+
+Please note that this project is released with a [Contributor Code of Conduct](code_of_conduct.md). By participating in this project you agree to abide by its terms.
+
+### Licence
+Copyright 2017 Province of British Columbia
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at 
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+This repository is maintained by [Low Carbon Fuels Branch](http://www2.gov.bc.ca/gov/content/industry/electricity-alternative-energy/transportation-energies/renewable-low-carbon-fuels). Click [here](https://github.com/bcgov/tfrs) for a complete list of our repositories on GitHub.

code_of_conduct.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behaviour by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviours that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting a project maintainer at [email protected] or 
+[email protected]. All complaints will be reviewed and investigated 
+and will result in a response that is deemed necessary and appropriate to the 
+circumstances. Maintainers are obligated to maintain confidentiality with regard 
+to the reporter of an incident.
+
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

contributing.md

@@ -0,0 +1,9 @@
+# How to contribute
+
+Government employees, public and members of the private sector are encouraged to contribute to the repository by forking and submitting a pull request.
+
+(If you are new to GitHub, you might start with a [basic tutorial](https://help.github.com/articles/set-up-git) and check out a more detailed guide to [pull requests](https://help.github.com/articles/using-pull-requests/).)
+
+Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the master.
+
+All contributors retain the original copyright to their stuff, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users <b>under the terms of the license under which this project is distributed.</b>