Skip to content

Commit

Permalink
clean readme
Browse files Browse the repository at this point in the history
  • Loading branch information
williambelle committed Jan 3, 2020
1 parent 74207f4 commit dfecf1c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
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

0 comments on commit dfecf1c

Please sign in to comment.