diff --git a/README.md b/README.md index 65747ab6..9a99d338 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,28 @@ -# Cachet - -[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy) +# 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). +![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.** Please feel free to contribute! -## Progress - -![Current progress](https://dl.dropboxusercontent.com/u/7323096/Cachet.png) - -[What's next for Cachet?](http://james-brooks.uk/whats-next-for-cachet/) - -## Installation +# 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. -## Current Features +# Looking to contribute? -- Uses SQLite/MySQL (ClearDB on Heroku). -- Report statuses on: - + Incidents - + Components -- Uses Bootstrap 3 for a easy to modify, smooth layout. +Are you looking to help out and contribute towards Cachet, awesome! There is a lot to do before the [first milestone](https://github.com/jbrooksuk/Cachet/milestones/First%20Release) is reached, including: -## 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) +- **Revamp the existing design** [#2](/issues/2). Whether you think that we should drop Bootstrap and we use a custom framework or we apply awesome styles, fork Cachet, make your changes and propose them! + + A good design for Cachet needs to also support a Setup and Management backend. +- **Setup Page** [#12](/issues/12). Work has started on this, but there is a lot more that needs to be setup including; users, components, incidents and templates. +- **Management Panel** [#11](/issues/11). Currently there is no way to get the incidents and components into the database without a bit of messing around. +- **API** [#3](/issues/3). All good services need an API and Cachet is no exception. An API will allow third-party integration and vice-versa. # License