Cachet/README.md

# Cachet

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

Cachet is an open source PHP status page system using the Laravel framework.

For more information on why I started developing Cachet, check out my [blog post](http://james-brooks.uk/cachet/?utm_source=github&utm_medium=readme&utm_campaign=github-cachet). [A demo, deployed to Heroku](https://cachet.herokuapp.com).

**Currently in development.** Please feel free to contribute!

## Progress

![Current progress](https://dl.dropboxusercontent.com/u/7323096/Cachet.png)

## Installation

See the [INSTALL.md](/INSTALL.md) document for more information. If you'd like to add more documentation, please create a Pull Request, I'd be happy to merge!

## Current Features

- Uses SQLite/MySQL.
- Report statuses on:
    + Incidents
    + Components
- Uses Bootstrap 3 for a easy to modify, smooth layout.

## Goals

- [ ] Configuration:
    - [ ] Individual sites.
    - [ ] Colours and themes.
- [ ] Incident reporting:
    - [ ] Manual.
    - [ ] Third-party integration to automatically create incidents.
- [ ] Incident report templates.
- [ ] RESTful API.
- [ ] Web Hooks.
- [ ] Administration panel:
    - [ ] Create new incidents.
    - [ ] Add components.
    - [ ] Report on components.
- [ ] Third party integration:
    - [ ] Connect to third-party services and auto report using the API.
    - [ ] Add components via third-party sources.
- [x] Heroku Button Support [#5](https://github.com/jbrooksuk/Cachet/issues/5)

# License

[MIT license](http://jbrooksuk.mit-license.org)
Update README for project name change 2014-11-16 22:54:08 +00:00			`# Cachet`
First commit, Laravel is setup! 2014-11-16 22:26:08 +00:00
Having a quick go with Heroku buttons! 2014-11-20 19:29:06 +00:00			`[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)`

Update README for project name change 2014-11-16 22:54:08 +00:00			`Cachet is an open source PHP status page system using the Laravel framework.`
First commit, Laravel is setup! 2014-11-16 22:26:08 +00:00
Demo link to Heroku 2014-11-21 09:03:28 +00:00			`For more information on why I started developing Cachet, check out my [blog post](http://james-brooks.uk/cachet/?utm_source=github&utm_medium=readme&utm_campaign=github-cachet). [A demo, deployed to Heroku](https://cachet.herokuapp.com).`
Added link to blog post for Cachet 2014-11-20 17:47:32 +00:00
Update README 2014-11-16 22:29:08 +00:00			`Currently in development. Please feel free to contribute!`
First commit, Laravel is setup! 2014-11-16 22:26:08 +00:00
Include screenshot of current progress 2014-11-16 23:37:47 +00:00			`## Progress`

Updated screenshot 2014-11-19 13:40:21 +00:00			`![Current progress](https://dl.dropboxusercontent.com/u/7323096/Cachet.png)`
Include screenshot of current progress 2014-11-16 23:37:47 +00:00
Started on Installation instructions. 2014-11-20 17:27:01 +00:00			`## Installation`

Flesh out installation part 2014-11-20 17:41:37 +00:00			`See the [INSTALL.md](/INSTALL.md) document for more information. If you'd like to add more documentation, please create a Pull Request, I'd be happy to merge!`
Started on Installation instructions. 2014-11-20 17:27:01 +00:00
Include features and more goals within the readme 2014-11-17 00:06:37 +00:00			`## Current Features`

Update README to reflect more goals 2014-11-20 17:18:38 +00:00			`- Uses SQLite/MySQL.`
Include features and more goals within the readme 2014-11-17 00:06:37 +00:00			`- Report statuses on:`
			`+ Incidents`
			`+ Components`
			`- Uses Bootstrap 3 for a easy to modify, smooth layout.`

Update README 2014-11-16 22:29:08 +00:00			`## Goals`
First commit, Laravel is setup! 2014-11-16 22:26:08 +00:00
Update README 2014-11-16 22:29:08 +00:00			`- [ ] Configuration:`
			`- [ ] Individual sites.`
			`- [ ] Colours and themes.`
Include features and more goals within the readme 2014-11-17 00:06:37 +00:00			`- [ ] Incident reporting:`
Update README 2014-11-16 22:29:08 +00:00			`- [ ] Manual.`
			`- [ ] Third-party integration to automatically create incidents.`
Added Incident report templates as a goal 2014-11-21 15:47:05 +00:00			`- [ ] Incident report templates.`
Update README to reflect more goals 2014-11-20 17:18:38 +00:00			`- [ ] RESTful API.`
Added Web Hooks as a goal 2014-11-22 13:12:36 +00:00			`- [ ] Web Hooks.`
Include features and more goals within the readme 2014-11-17 00:06:37 +00:00			`- [ ] Administration panel:`
			`- [ ] Create new incidents.`
			`- [ ] Add components.`
			`- [ ] Report on components.`
Update README to reflect more goals 2014-11-20 17:18:38 +00:00			`- [ ] Third party integration:`
			`- [ ] Connect to third-party services and auto report using the API.`
			`- [ ] Add components via third-party sources.`
Heroku Button Support is done 2014-11-21 09:02:00 +00:00			`- [x] Heroku Button Support [#5](https://github.com/jbrooksuk/Cachet/issues/5)`
First commit, Laravel is setup! 2014-11-16 22:26:08 +00:00
Update README 2014-11-16 22:29:08 +00:00			`# License`
First commit, Laravel is setup! 2014-11-16 22:26:08 +00:00
Update README 2014-11-16 22:29:08 +00:00			`[MIT license](http://jbrooksuk.mit-license.org)`