voltage.js

1.0.8 • Public • Published

travisci codecov code style: prettier

A library for websites to detect user's connection status. Certified Lit 🔥🔥 Accepting PRs

  • A simple JavaScript library to provide a functionality for websites to detect online / offline connection status.

Table of Contents

Installing / Getting started

A quick introduction of the minimal setup you need to get a up & running.

$ npm install voltage.js

Usage

Here's a brief intro about what a developer must do in order to start developing the project further:

Manually

  • Download the latest distribution from github release.
  • Add voltage.min.css and voltage.min.js to your html page.
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Voltage.JS Example</title>
    <link rel="stylesheet" href="voltage.min.css" />
  </head>
  <body>
    <div>Example Page</div>

    <script src="voltage.min.js"></script>
  </body>
</html>

Using npm

An example implementation using react could be found here.

  • Add the latest npm package to the project.
  • Import voltage.css and voltage.js to your frontend.
$ npm i voltage.js

Contributors

contributors

License

MIT © Murshid Azher.

Package Sidebar

Install

npm i voltage.js

Weekly Downloads

4

Version

1.0.8

License

MIT

Unpacked Size

17 kB

Total Files

10

Last publish

Collaborators

  • murshidazher