added doc

README.md

@@ -1,2 +1,50 @@
-# uptimerobot-proxy
-Simple proxy for uptimerobot web-hooks
+<!-- markdownlint-disable -->
+<h1 align="center" style="margin:1em">
+  <img src="./docs/static/logo.png"
+       alt="jahia2wp"
+       width="200">
+  <p>Uptime Proxy</p>
+</h1>
+
+<h4 align="center">
+  Forward your UptimeRobots alerts where you want, in the format you choose
+</h4>
+
+<p align="center">
+  <a href="https://github.com/ebreton/uptimerobot-proxy/blob/master/docs/CHANGELOG.md">
+    <img src="https://img.shields.io/github/release/ebreton/uptimerobot-proxy.svg"
+         alt="Changelog">
+  </a>
+  <a href="https://travis-ci.org/ebreton/uptimerobot-proxy">
+    <img src="https://travis-ci.org/ebreton/uptimerobot-proxy.svg?branch=master"
+         alt="Travis">
+  </a>
+  <a href="https://codecov.io/gh/ebreton/uptimerobot-proxy">
+    <img src="https://codecov.io/gh/ebreton/uptimerobot-proxy/branch/master/graph/badge.svg"
+         alt="Codecov" />
+  </a>
+  <a href="https://github.com/ebreton/uptimerobot-proxy/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg"
+         alt="License" />
+  </a>
+</p>
+<br>
+
+## Overview
+
+coming ...
+
+
+## Install and Usage
+
+coming ...
+
+## Changelog
+
+All notable changes to this project are documented in [CHANGELOG.md](./docs/CHANGELOG.md).
+
+## Contribution
+
+Check out [CONTRIBUTING.md](./docs/CONTRIBUTING.md) for more details
+
+As well as our [CODE_OF_CONDUCT.md](./docs/CODE_OF_CONDUCT.md), where we pledge to making participation in our project and our community a harassment-free experience for everyone

docs/CHANGELOG.md

@@ -0,0 +1,47 @@
+<!-- markdownlint-disable -->
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+Table of releases
+-----------------
+
+<!-- TOC depthFrom:2 depthTo:2 orderedList:false -->
+
+- [[0.3.x] - 2018-02-07](#03x---2018-02-07)
+- [[0.2.x] - 2018-02-06](#02x---2018-02-06)
+- [[0.1.x] - 2018-02-04](#01x---2018-02-04)
+- [[0.1.0] - 2018-02-03](#010---2018-02-03)
+
+<!-- /TOC -->
+
+## [0.3.x] - 2018-02-07
+
+1. Added Documentation
+1. Enabled forwarding to given url E2EMONITORING_URL 
+1. Displayed JSON export in GUI, along with time since alert received
+1. Added JSON export of events in format expected by E2EMonitoring
+
+## [0.2.x] - 2018-02-06
+
+1. Enable database storage with E2EMONITORING_URL 
+1. Added support for sqlite3 & postgreSQL (through SQLAlchemy)
+1. Displayed JSON export in GUI, along with time since alert received
+
+## [0.1.x] - 2018-02-04 
+
+1. Created python objects for events and storage
+1. Created endpoints and simple GUI
+1. Create Makefile to 
+   - display / use / set-up environment variables
+   - run server in 3 modes: flask-dev, gunicorn, heroku-local
+   - run tests & coverage
+   - deploy
+
+
+## [0.1.0] - 2018-02-03
+
+- initial revision

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,72 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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 behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jahia2wp at groupes.epfl.ch. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct/), version 1.4.
+
+[homepage]: https://www.contributor-covenant.org

docs/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to Jahia2wp
+
+As an open source project, we always welcome contributions of many forms.
+
+Examples of contributions include:
+
+1. Submitting issues for any feature enhancements, bugs or documentation problems.
+1. Fixing open issues by sending PRs
+1. Adding documentation
+
+**Warning**: In order to ease the process, and set expectations, be sure to submit a PR after discussing it in an issue. Non-trivial pull requests (anything more than fixing a typo) without issues will be closed!
+
+When discussing changes and issues, please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+As you have surely seen before reaching this page, most of the project is written in python. Hence a few practices that should guide you:
+
+1. code should respect [flake8](http://flake8.pycqa.org/en/latest/) conventions
+1. new code should come with automatic tests
+1. all tests (new and existing) should pass
+1. coverage should not decrease (codcov will automatically comment the PRs with a coverage report)
+1. high level documentation should be written in [markdown](https://daringfireball.net/projects/markdown/)

docs/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+**From issue**: #xx
+**Targetted version**: x.x.x
+
+**High level changes:**
+
+1. list here the changes in usage, from a user point of view
+1. ...
+
+**Low level changes:**
+
+1. list here the modification made in the code structure, from a developer point of view
+1. ...