Skip to content
This repository has been archived by the owner on Oct 9, 2019. It is now read-only.

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
freekmurze committed Dec 11, 2016
1 parent e104eb1 commit f27c2c4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 26 deletions.
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Expand Up @@ -46,8 +46,6 @@ If the project maintainer has any additional requirements, you will find them li

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
Expand Down
28 changes: 5 additions & 23 deletions README.md
Expand Up @@ -13,7 +13,7 @@ Here are some examples of how the Slack notifications look like:
<img src="https://docs.spatie.be/images/uptime-monitor/ssl-expiring-soon.jpg"><br />


Under the hood the uptime-monitor is a vanilla Laravel 5.3 application with the [laravel-uptime-monitor](https://docs.spatie.be/laravel-uptime-monitor) installed into it.
Under the hood the uptime-monitor is a vanilla Laravel 5.3 application with the [laravel-uptime-monitor](https://docs.spatie.be/laravel-uptime-monitor) installed into it. If you know your way around Laravel, it's recommended that you use [laravel-uptime-monitor](https://docs.spatie.be/laravel-uptime-monitor) instead of this app.

## Installation

Expand All @@ -33,7 +33,7 @@ php <installation path>/artisan schedule:run
```

2. Specify a Slack webhook url in the `notifications.slack.url` key
in `configuration.php` found in the installation directory.
in `configuration.php` found in the installation directory. You can [create a new webhook url](https://my.slack.com/services/new/incoming-webhook/) on the Slack website.

## Configuration

Expand Down Expand Up @@ -192,15 +192,11 @@ Under the hood the uptime-monitor is a vanilla Laravel 5.3 application with our

By default the application will use an `sqlite` database located at `<installation directory>/database.sqlite` to store all monitors.


## API

Currently this package does not offer an API, if you need that take a look at [this package](https://github.com/LKDevelopment/laravel-uptime-monitor-api).

## Documentation
You'll find the documentation on [https://docs.spatie.be/laravel-uptime-monitor/v1](https://docs.spatie.be/laravel-uptime-monitor/v1). It includes detailed info on how to install and use the package.

Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the uptime monitor? Feel free to [create an issue on GitHub](https://github.com/spatie/laravel-uptime-monitor/issues), we'll try to address it as soon as possible.
You'll find the documentation of the underlying `laravel-uptime-monitor` package on [https://docs.spatie.be/laravel-uptime-monitor/v1](https://docs.spatie.be/laravel-uptime-monitor/v1).

Find yourself stuck using this app or the underlying package? Found a bug? Do you have general questions or suggestions for improving the uptime monitor? Feel free to [create an issue on GitHub](https://github.com/spatie/laravel-uptime-monitor/issues), we'll try to address it as soon as possible.

## Postcardware

Expand All @@ -214,20 +210,6 @@ The best postcards will get published on the open source page on our website.

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

To run the tests you'll have to start the included node based server first in a separate terminal window.

```bash
cd tests/server
./start_server.sh
```

With the server running, you can start testing.
```bash
vendor/bin/phpunit
```

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
Expand Down
3 changes: 2 additions & 1 deletion post-install-instructions.txt
Expand Up @@ -9,7 +9,8 @@ php <installation path>/artisan schedule:run
---

2. Specify a Slack webhook url in the notifications.slack.url key
in configuration.php.
in configuration.php. You can create a webhook url on the slack
website: https://my.slack.com/services/new/incoming-webhook/

3. Add your first monitor by running:
---
Expand Down

0 comments on commit f27c2c4

Please sign in to comment.