Update docs

purduehackers · Nov 14, 2023 · ab4ca84 · ab4ca84
1 parent 3dd55bc
commit ab4ca84
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -177,3 +177,18 @@ returns {
 }
 */
 ```
+
+## Lightning Time Clock React Hook
+
+This package includes a React Hook for implementing a Lightning Time clock in your React app:
+
+```javascript
+import { useLightningTimeClock } from '@purduehackers/time/react'
+
+export default function MyComponent() {
+  const { lightningTimeClock, normalTimeClock, timeColors } =
+    useLightningTimeClock()
+
+  return <p>{lightningTimeClock}</p>
+}
+```
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@purduehackers/time",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "convert between traditional time and lightning time ⚡️",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",