readme.md

Ladder Summary

file The file is the README for the **`is-up`** npm package. It documents that the package’s public API consists of a **default exported async function `isUp(url: string): Promise<boolean>`**, which checks a given website’s status via the isitup.org API and resolves to `true` if the site is up and `false` otherwise. No classes are exported.

# is-up [![Build Status](https://travis-ci.org/sindresorhus/is-up.svg?branch=master)](https://travis-ci.org/sindresorhus/is-up)

> Check whether a website is up or down using the [isitup.org](http://isitup.org) API

## CLI

```

$ npm install --global is-up

```

$ is-up --help

Example

is-up sindresorhus.com

✔︎ Up

```

## API

```

$ npm install --save is-up

```

```js

var isUp = require('is-up');

isUp('sindresorhus.com', function (err, up) {

console.log(up);

//=> true

});

```

## License