Cachet/README.md

# Cachet [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)
[![Build Status](http://img.shields.io/travis/cachethq/Cachet.svg?style=flat-square)](https://travis-ci.org/cachethq/Cachet)
[![Code Climate](http://img.shields.io/codeclimate/github/cachethq/Cachet.svg?style=flat-square)](https://codeclimate.com/github/cachethq/Cachet)
[![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](http://jbrooksuk.mit-license.org)