README
voltage.js
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
andvoltage.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>
npm
Using An example implementation using react could be found here.
- Add the latest npm package to the project.
- Import
voltage.css
andvoltage.js
to your frontend.
$ npm i voltage.js
Contributors
License
MIT © Murshid Azher.