Update README.md and CONTRIBUTING.md files
This commit is contained in:
@@ -31,3 +31,39 @@ If you're feeling adventurous, you can become a Git & GitHub master with the [Gi
|
|||||||
## .editorconfig
|
## .editorconfig
|
||||||
|
|
||||||
You should also make use of the [.editorconfig](/.editorconfig) file found within the root of the repository. It'll make sure that your editor is setup with the same file settings.
|
You should also make use of the [.editorconfig](/.editorconfig) file found within the root of the repository. It'll make sure that your editor is setup with the same file settings.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Contributing as a non-developer/non-designer
|
||||||
|
|
||||||
|
We're always looking for new [translations](#translations).
|
||||||
|
|
||||||
|
Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated.
|
||||||
|
|
||||||
|
## Contributing as a designer
|
||||||
|
|
||||||
|
As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet!
|
||||||
|
|
||||||
|
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. Run `gulp`
|
||||||
|
3. Make your changes to the SCSS files in `./resources/assets/sass/`
|
||||||
|
|
||||||
|
If you're making a lot of changes, you'll find that running `gulp watch` will make life easier for you!
|
||||||
|
|
||||||
|
When you're happy with your changes, please run `gulp --production` to minify the assets.
|
||||||
|
|
||||||
|
## Contributing as a developer
|
||||||
|
|
||||||
|
Built using [Laravel](https://laravel.com).
|
||||||
|
|
||||||
|
We use these extra dependencies to develop Cachet:
|
||||||
|
|
||||||
|
- Node.js
|
||||||
|
- Gulp
|
||||||
|
- Git
|
||||||
|
|
||||||
|
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.
|
||||||
|
|||||||
72
README.md
72
README.md
@@ -1,73 +1,37 @@
|
|||||||
# Cachet
|
<p align="center"><img src="/public/img/cachet-logo@2x.png"></p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
[](https://styleci.io/repos/26730195/)
|
[](https://styleci.io/repos/26730195/)
|
||||||
[](https://travis-ci.org/CachetHQ/Cachet)
|
[](https://travis-ci.org/CachetHQ/Cachet)
|
||||||
[](LICENSE)
|
[](LICENSE)
|
||||||
[](http://translate.cachethq.io/project/cachet)
|
[](http://translate.cachethq.io/project/cachet)
|
||||||
[](https://github.com/CachetHQ/Cachet/releases)
|
[](https://github.com/CachetHQ/Cachet/releases)
|
||||||
|
</p>
|
||||||

|
|
||||||
|
|
||||||
Cachet is a beautiful and powerful open source status page system.
|
Cachet is a beautiful and powerful open source status page system.
|
||||||
|
|
||||||
## Features
|
## Overview
|
||||||
|
|
||||||
- List your services components
|
- List your service components
|
||||||
- Log incidents
|
- Report incidents
|
||||||
- Apply custom CSS to the status page
|
- Customise the look of your status page
|
||||||
- Markdown support for incident messages
|
- Markdown support for incident messages
|
||||||
- JSON API
|
- A powerful JSON API
|
||||||
- Translated into eleven languages
|
|
||||||
- Metrics
|
- Metrics
|
||||||
- Cross-database support: MySQL, PostgreSQL and SQLite
|
- Multi-lingual
|
||||||
- Subscriber notifications via Email
|
- Subscriber notifications via email
|
||||||
- Two factor authentication using Google Authenticator
|
- Two factor authentication
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- PHP 5.5.9+ or newer
|
- PHP 5.5.9+ or newer
|
||||||
- HTTP server with PHP support (eg: Apache, Nginx, Caddy)
|
- HTTP server with PHP support (eg: Apache, Nginx, Caddy)
|
||||||
- [Composer](https://getcomposer.org)
|
- [Composer](https://getcomposer.org)
|
||||||
|
- A supported database: MySQL, PostgreSQL or SQLite
|
||||||
## I'm looking to contribute to this awesome project!
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
We're always looking for new [translations](#translations).
|
|
||||||
|
|
||||||
Of course bug reports, feature requests and [documentation](https://docs.cachethq.io) are always appreciated.
|
|
||||||
|
|
||||||
### Contributing as a designer
|
|
||||||
|
|
||||||
As Cachet gains new features, the design and ideas that were once a perfect fit need updating and in some cases designing from scratch. This is where you come in! Fancy giving Cachet a lick of paint? Sweet!
|
|
||||||
|
|
||||||
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. 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 make life easier for you!
|
|
||||||
|
|
||||||
### Contributing as a developer
|
|
||||||
|
|
||||||
Built using [Laravel](https://laravel.com).
|
|
||||||
|
|
||||||
We use these extra dependencies to develop Cachet:
|
|
||||||
|
|
||||||
- Node.js
|
|
||||||
- Gulp
|
|
||||||
- Git
|
|
||||||
|
|
||||||
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
|
## Installation, Upgrades and Documentation
|
||||||
|
|
||||||
Documentation is found at [https://docs.cachethq.io](https://docs.cachethq.io).
|
You can find documentation at [https://docs.cachethq.io](https://docs.cachethq.io).
|
||||||
|
|
||||||
Here are some useful quick links:
|
Here are some useful quick links:
|
||||||
|
|
||||||
@@ -81,18 +45,12 @@ To test out the demo, you may login to the [Dashboard](https://demo.cachethq.io/
|
|||||||
- **Username:** `test` or `test@test.com`
|
- **Username:** `test` or `test@test.com`
|
||||||
- **Password:** `test123`
|
- **Password:** `test123`
|
||||||
|
|
||||||
The demo is reset every half hour.
|
> The demo resets every 30 minutes.
|
||||||
|
|
||||||
## Translations
|
## Translate Cachet
|
||||||
|
|
||||||
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
|
## 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)
|
We offer a professional installation service. To find out more, email us at [support@alt-three.com](mailto:support@alt-three.com?Cachet Installation)
|
||||||
|
|||||||
Reference in New Issue
Block a user