diff --git a/README.md b/README.md index 98079509..66beda0e 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ # Cachet [![StyleCI](https://styleci.io/repos/26730195/shield)](https://styleci.io/repos/26730195/) -[![Build Status](https://img.shields.io/travis/CachetHQ/Cachet/master.svg?style=flat-square)](https://travis-ci.org/CachetHQ/Cachet) +[![Build Status](https://img.shields.io/travis/CachetHQ/Cachet/2.3.svg?style=flat-square)](https://travis-ci.org/CachetHQ/Cachet) [![Software License](https://img.shields.io/badge/license-BSD3-brightgreen.svg?style=flat-square)](LICENSE) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/cachet/localized.svg)](http://translate.cachethq.io/project/cachet) [![Packagist](https://img.shields.io/packagist/v/cachethq/cachet.svg?style=flat-square)](https://packagist.org/packages/cachethq/cachet) ![Screenshot](https://cachethq.io/img/main-interface.jpg) -Cachet is a beautiful and powerful open source status page system, a free replacement to services such as StatusPage.io, Status.io and others. - -## Supporting Cachet - -Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the [Cachet Patreon campaign](https://patreon.com/jbrooksuk). +Cachet is a beautiful and powerful open source status page system. ## Features @@ -25,11 +21,7 @@ Cachet is a BSD-3-licensed open source project. If you'd like to support future - Metrics - Cross-database support: MySQL, PostgreSQL and SQLite - Subscriber notifications via Email -- Two factor authentication, with Google Authenticator - -## Usage in production - -The `master` branch of this repository is a development branch and **should not** be used in production. Instead, please check out the latest tag release. +- Two factor authentication using Google Authenticator ## Requirements @@ -37,15 +29,15 @@ The `master` branch of this repository is a development branch and **should not* - Apache or Nginx server - [Composer](https://getcomposer.org) -## How to contribute +## I'm looking to contribute to this awesome project! -We're always looking for contributions that improve Cachet. It's easy to get started and you don't even need to know how to write a single line of code! +Sweet, we're always looking for contributions that improve Cachet! It's easy to get started and you don't even need to know how to write a single line of code! ### Contributing as a non-developer/non-designer -If you're one of the more linguistically talented people in the world who can speak and write more than just English, we're always looking for new [translations](#translations). +We're always looking for new [translations](#translations). -Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always being sought after. +Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated. ### Contributing as a designer @@ -56,26 +48,28 @@ You'll need to install Node.js, Bower and Gulp. To get started you can do the following: 1. Install Node.js and our dev dependencies. -2. Modify the SCSS files in `./resources/assets/sass/` +2. Make your changes to the SCSS files in `./resources/assets/sass/` 3. Run `gulp` -If you're making a lot of changes, you'll find that running `gulp watch` will really help you out! +If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you! ### Contributing as a developer -Built using [Laravel](https://laravel.com), Cachet is very easy to jump into. Have a look around you'll find it surprisingly easy! +Built using [Laravel](https://laravel.com). -These extra dependencies are required to develop Cachet: +We use these extra dependencies to develop Cachet: - Node.js - Gulp - Git -Once cloned to your local machine, you'll need some demo data! Simply run `php artisan cachet:seed` to get the demo installation on the go. +Once cloned to your local machine, you'll need some demo data! Run `php artisan cachet:seed` to get the demo installation ready for action. ## Installation, Upgrades and Documentation -You can now find our documentation at [https://docs.cachethq.io](https://docs.cachethq.io). +Documentation is found at [https://docs.cachethq.io](https://docs.cachethq.io). + +Here are some useful quick links: - [Installing Cachet](https://docs.cachethq.io/docs/installing-cachet) - [Getting started with Docker](https://docs.cachethq.io/docs/get-started-with-docker) @@ -84,25 +78,29 @@ You can now find our documentation at [https://docs.cachethq.io](https://docs.ca To test out the demo, you may login to the [Dashboard](https://demo.cachethq.io/dashboard) with the following: -- **Username:** test or test@test.com -- **Password:** test123 +- **Username:** `test` or `test@test.com` +- **Password:** `test123` The demo is reset every half hour. ### Release Notes -All releases are listed on the [Releases page](https://github.com/CachetHQ/Cachet/releases) of the [Cachet GitHub repository](https://github.com/CachetHQ/Cachet). On the Releases page, you can also find the release notes for each release. +We list releases on the [Releases page](https://github.com/CachetHQ/Cachet/releases) of the [Cachet GitHub repository](https://github.com/CachetHQ/Cachet). On the Releases page, you can also find the release notes for each release. ## Translations -A special thank you to our [translators](https://crowdin.com/project/cachet/activity_stream), who have allowed us to share Cachet with the world. If you'd like to contribute translations, please check out our [CrowdIn project](https://crowdin.com/project/cachet). +If you'd like to contribute translations, please check out our [CrowdIn project](https://crowdin.com/project/cachet). + +> Thank you to our [translators](https://crowdin.com/project/cachet/activity_stream), who have allowed us to share Cachet with the world! + +## Show your support + +Cachet is a BSD-3-licensed open source project. If you'd like to support future development, check out the [Patreon campaign](https://patreon.com/jbrooksuk). + +## Professional Installation Service + +We offer a professional installation service. To find out more, email us at [support@alt-three.com](mailto:support@alt-three.com?Cachet Installation) ## Security Vulnerabilities -If you discover a security vulnerability within Cachet, please send an e-mail to us at support@alt-three.com. All security vulnerabilities will be promptly addressed. - -## Installations - -We offer a paid installation service, which starts at $99 but is subject to change, dependant on your setup and infrastructure. - -To find out more, email us at support@alt-three.com +If you discover a security vulnerability within Cachet, please send an e-mail to us at support@alt-three.com. We handle all security vulnerabilities on a case-by-case basis.