Cachet/README.md

# Cachet

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
[![Build Status](https://img.shields.io/travis/cachethq/Cachet.svg?style=flat-square)](https://travis-ci.org/cachethq/Cachet)
[![Quality Score](https://img.shields.io/scrutinizer/g/cachethq/Cachet.svg?style=flat-square)](https://scrutinizer-ci.com/g/cachethq/Cachet)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/cachethq/Cachet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

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

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), for more read [What's next for Cachet?]([What's next for Cachet?](http://james-brooks.uk/whats-next-for-cachet/)) [A demo, deployed to Heroku](https://cachet.herokuapp.com).

**Currently in development. Things may change or break until a solid release has been announced.**

# Features

- List your services components.
- Log incidents.
- Override status page colors.
- Apply a custom stylesheet to the status page.
- Markdown support for incident messages.
- RESTful API.

# Requirements

- PHP 5.4 or newer
- Composer
- Node.js
    + Bower
    + Gulp
- mcrypt extension

# 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!

[Deploying to Heroku](/INSTALL.md#deploy-to-heroku) requires one-click to get started and no knowledge of PHP or Laravel afterwards.

# Translations

A special thank you to our translators, who have provided us with the chance to share Cachet with the world.

- **Andreas Karlsson** - Swedish
- **Marcin Kurczewski** - Polish
- **Pedro Maia** - Portuguese
- **Salvatore Gentile** - Italian
- **Joe Cohens, Salvatore Gentile** - Spanish

If you'd like to contribute translations, please check out our [CrowdIn project](https://crowdin.com/project/cachet).

# License

[MIT](LICENSE)
Fixed the license file and updated badges 2015-01-01 17:54:18 +00:00			`# Cachet`

			`[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)`
			`[![Build Status](https://img.shields.io/travis/cachethq/Cachet.svg?style=flat-square)](https://travis-ci.org/cachethq/Cachet)`
			`[![Quality Score](https://img.shields.io/scrutinizer/g/cachethq/Cachet.svg?style=flat-square)](https://scrutinizer-ci.com/g/cachethq/Cachet)`
			`[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)`
Update Gitter badge 2014-11-26 17:29:51 +00:00			`[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/cachethq/Cachet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)`
Having a quick go with Heroku buttons! 2014-11-20 19:29:06 +00:00
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
Clean up the README file. - Remove goals. - Move deploy button to header line. - Move screenshot up. - Keep both blog post links together. - Add a section on how to get started. 2014-11-24 10:43:08 +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), for more read [What's next for Cachet?]([What's next for Cachet?](http://james-brooks.uk/whats-next-for-cachet/)) [A demo, deployed to Heroku](https://cachet.herokuapp.com).`
What's next for Cachet link in the README 2014-11-24 09:10:56 +00:00
Tidy up the README 2014-12-30 10:50:31 +00:00			`Currently in development. Things may change or break until a solid release has been announced.`
Clean up the README file. - Remove goals. - Move deploy button to header line. - Move screenshot up. - Keep both blog post links together. - Add a section on how to get started. 2014-11-24 10:43:08 +00:00
Add features list to README 2014-12-22 12:46:25 +00:00			`# Features`

Reword component feature 2014-12-31 21:13:51 +00:00			`- List your services components.`
Add features list to README 2014-12-22 12:46:25 +00:00			`- Log incidents.`
			`- Override status page colors.`
			`- Apply a custom stylesheet to the status page.`
Added Markdown feature 2014-12-30 10:47:27 +00:00			`- Markdown support for incident messages.`
Added api to features 2014-12-31 21:16:45 +00:00			`- RESTful API.`
Add features list to README 2014-12-22 12:46:25 +00:00
Added list of requirements 2014-12-30 22:09:22 +00:00			`# Requirements`

			`- PHP 5.4 or newer`
			`- Composer`
			`- Node.js`
			`+ Bower`
			`+ Gulp`
			`- mcrypt extension`

Clean up the README file. - Remove goals. - Move deploy button to header line. - Move screenshot up. - Keep both blog post links together. - Add a section on how to get started. 2014-11-24 10:43:08 +00:00			`# Installation`
Started on Installation instructions. 2014-11-20 17:27:01 +00:00
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
README changes 2014-11-24 10:22:46 +00:00			`[Deploying to Heroku](/INSTALL.md#deploy-to-heroku) requires one-click to get started and no knowledge of PHP or Laravel afterwards.`

Translations! 2014-12-27 17:54:58 +00:00			`# Translations`

			`A special thank you to our translators, who have provided us with the chance to share Cachet with the world.`

			`- Andreas Karlsson - Swedish`
			`- Marcin Kurczewski - Polish`
			`- Pedro Maia - Portuguese`
			`- Salvatore Gentile - Italian`
Joe and Salvatore are both doing Spanish 2014-12-28 11:06:26 +00:00			`- Joe Cohens, Salvatore Gentile - Spanish`
Translations! 2014-12-27 17:54:58 +00:00
Link to the CrowdIn project 2014-12-27 18:02:00 +00:00			`If you'd like to contribute translations, please check out our [CrowdIn project](https://crowdin.com/project/cachet).`

Update README 2014-11-16 22:29:08 +00:00			`# License`
First commit, Laravel is setup! 2014-11-16 22:26:08 +00:00
Fixed the license file and updated badges 2015-01-01 17:54:18 +00:00			`[MIT](LICENSE)`