Skip to content

Commit

Permalink
improve readme doc api
Browse files Browse the repository at this point in the history
  • Loading branch information
williambelle committed Apr 5, 2019
1 parent 76e293d commit 0e5fc6e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@ Examples:
##### Startup options

`-v`, `--version`
Print is-epfl-down's version.
Print `is-epfl-down`'s version.

`-h`, `--help`
Print is-epfl-down command line options.
Print `is-epfl-down` command line options.

##### Hosts and urls options

Expand All @@ -82,7 +82,7 @@ Test your own list of subdomains or urls. File must be a path to a json file.
A json example:

```json
["actu","blogs","memento","wiki"]
["actu","blogs","memento","wiki","http://www.epfl.ae"]
```

`-f`, `--faculties`
Expand Down Expand Up @@ -143,7 +143,7 @@ npm i is-epfl-down --save
```javascript
var isEpflDown = require('is-epfl-down');

isEpflDown(['www','actu','blogs']).then(function(isDown) {
isEpflDown(['www','actu','blogs','http://www.epfl.ae']).then(function(isDown) {
console.log(isDown)
//=> false
});
Expand All @@ -162,15 +162,15 @@ Returns a Promise with a boolean as parameter.

Type: `array`

A list of subdomain from EPFL.
A list of subdomain from EPFL or urls.

##### options

Type: `object`

Any of the following options.

##### timeout
###### timeout

Type: `number`

Expand Down

0 comments on commit 0e5fc6e

Please sign in to comment.