Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean readme #34

Merged
merged 1 commit into from
Jan 3, 2020
Merged

Clean readme #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,19 +114,19 @@ No alarm sound.

##### Examples

Testing the main site:
Test the main site:
`is-epfl-down -m`

Testing EPFL services:
Test EPFL services:
`is-epfl-down -s`

Testing your own config:
Test your own config:
`is-epfl-down --config=/path/to/my/config.json`

Testing EPFL faculties with a timeout of 2s:
Test EPFL faculties with a timeout of 2s:
`is-epfl-down -f -t 2000`

Testing EPFL faculties with a specific alarm sound in case of failure:
Test EPFL faculties with a specific alarm sound in case of failure:
`is-epfl-down -f -a /path/to/my/sound.mp3`

API
Expand All @@ -141,15 +141,15 @@ npm i is-epfl-down --save
### Usage

```javascript
var isEpflDown = require('is-epfl-down');
const isEpflDown = require('is-epfl-down');

isEpflDown(['www','actu','blogs','http://www.epfl.ae']).then(function(isDown) {
console.log(isDown)
console.log(isDown);
//=> false
});

isEpflDown(['unicorn'], {timeout: 1000}).then(function(isDown) {
console.log(isDown)
console.log(isDown);
//=> true
});
```
Expand Down Expand Up @@ -192,13 +192,13 @@ See [Contributing](CONTRIBUTING.md).
Developers
----------

* [Olivier Bieler](https://github.com/obieler)
* [William Belle](https://github.com/williambelle)
* [Olivier Bieler](https://github.com/obieler)
* [William Belle](https://github.com/williambelle)

Contributors
------------

* [Nicolas Borboën](https://github.com/ponsfrilus)
* [Nicolas Borboën](https://github.com/ponsfrilus)

License
-------
Expand Down