add better descriptions and change variable name in example

rehooks · Oct 25, 2018 · ee55ae9 · ee55ae9
1 parent c10d13d
commit ee55ae9
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # `@rehooks/online-status`
 
-> React hook for subscribing to online status
+> React hook for subscribing to online/offline events and the `navigator.onLine` property to see current status
 
 > **Note:** This is using the new [React Hooks API Proposal](https://reactjs.org/docs/hooks-intro.html)
 > which is subject to change until React 16.7 final.

diff --git a/example.js b/example.js
@@ -1,9 +1,9 @@
 import React from "react";
 import { render } from "react-dom";
-import useOfflineStatus from "./";
+import useOnlineStatus from "./";
 
 function App() {
-  let onlineStatus = useOfflineStatus();
+  let onlineStatus = useOnlineStatus();
   return (
     <div>
       <h1>You are {onlineStatus ? "Online" : "Offline"}</h1>

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@rehooks/online-status",
   "version": "1.0.0",
-  "description": "React hook for monitoring online status",
+  "description": "React hook for subscribing to online/offline events and the `navigator.onLine` property to see current status",
   "main": "index.js",
   "repository": "https://github.com/rehooks/online-status",
   "author": "@mathdroid",