add README. (#4)
This commit is contained in:
parent
82674fdf73
commit
dfbce3da0c
44
README.md
44
README.md
@ -1,24 +1,42 @@
|
||||
# README
|
||||
<p align="center">
|
||||
<a href="https://twitter.com/ProctorUEng">
|
||||
<img src="https://s3-us-west-2.amazonaws.com/dev-team-resources/storm-wordmark.svg" width=320 height=125>
|
||||
</a>
|
||||
|
||||
This README would normally document whatever steps are necessary to get the
|
||||
application up and running.
|
||||
<p align="center">
|
||||
self-hosted website monitoring service.
|
||||
</p>
|
||||
</p>
|
||||
|
||||
Things you may want to cover:
|
||||
<br>
|
||||
|
||||
* Ruby version
|
||||
> Storm is currently a WIP.
|
||||
|
||||
* System dependencies
|
||||
> Storm is a 100% open-source platform that provides a self-hosted monitoring
|
||||
service to your web apps. It provides Slack notifications, AWS server reboot
|
||||
within Slack, and many more useful features.
|
||||
|
||||
* Configuration
|
||||
## Table of contents
|
||||
|
||||
* Database creation
|
||||
- [Status](#status)
|
||||
- [Deploy to Heroku](#deploy-to-heroku)
|
||||
- [Developing](#developing)
|
||||
|
||||
* Database initialization
|
||||
## Status
|
||||
|
||||
* How to run the test suite
|
||||
[![CircleCI](https://circleci.com/gh/ProctorU/storm.svg?style=svg)](https://circleci.com/gh/ProctorU/storm)
|
||||
|
||||
* Services (job queues, cache servers, search engines, etc.)
|
||||
## Deploy to Heroku
|
||||
|
||||
* Deployment instructions
|
||||
- [ ] TODO: add "Deploy to Heroku" button.
|
||||
|
||||
* ...
|
||||
## Developing
|
||||
|
||||
1. Thank you! We love [our contributors](https://github.com/ProctorU/storm/graphs/contributors)!
|
||||
1. Clone the repository.
|
||||
1. Install missing dependencies: `bundle install`.
|
||||
1. Setup your database: `rails db:setup`.
|
||||
1. Make your changes in a thoughtfully-named branch.
|
||||
1. Ensure 1:1 test coverage.
|
||||
1. Submit a [Pull Request](https://github.com/ProctorU/storm/pulls)!
|
||||
1. Celebrate! :tada:
|
||||
|
Loading…
Reference in New Issue
Block a user