Skip to content

Commit f85a3a2

Browse files
committed
docs(docs): simplify timer hook positioning
1 parent 6449b13 commit f85a3a2

File tree

7 files changed

+9
-9
lines changed

7 files changed

+9
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @crup/react-timer-hook
22

3-
> Reliable React timer hooks for countdowns, stopwatches, clocks, polling schedules, and many independent timer lifecycles.
3+
> React timer hooks for countdowns, stopwatches, clocks, polling schedules, and many independent timer lifecycles.
44
55
[![npm alpha](https://img.shields.io/npm/v/%40crup%2Freact-timer-hook/alpha?label=npm%20alpha&color=00b894)](https://www.npmjs.com/package/@crup/react-timer-hook?activeTab=versions)
66
[![npm downloads](https://img.shields.io/npm/dm/%40crup%2Freact-timer-hook?color=0f766e)](https://www.npmjs.com/package/@crup/react-timer-hook)

docs-site/docs/api/use-timer.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: useTimer
3-
description: API reference for one reliable timer lifecycle.
3+
description: API reference for one timer lifecycle.
44
---
55

66
# useTimer

docs-site/docs/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: Reliable React timers
2+
title: React timer hooks
33
slug: /
44
description: React timer primitives for countdowns, stopwatches, clocks, polling schedules, and many independent timer lifecycles.
55
---
66

77
import RecipePlayground from '@site/src/components/RecipePlayground';
88
import { StopwatchSample, AbsoluteCountdownSample, TimerGroupSample } from '../samples/recipes';
99

10-
# Reliable React timers
10+
# React timer hooks
1111

1212
`@crup/react-timer-hook` gives React apps a small timer lifecycle primitive instead of a formatting-heavy timer component.
1313

docs-site/docusaurus.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const docsSiteDir = path.dirname(fileURLToPath(import.meta.url));
88

99
const config: Config = {
1010
title: '@crup/react-timer-hook',
11-
tagline: 'Reliable React timer primitives for real apps.',
11+
tagline: 'React timer primitives for real apps.',
1212
favicon: 'img/favicon.svg',
1313
url: 'https://crup.github.io',
1414
baseUrl: '/react-timer-hook/',

docs-site/static/img/social-card.svg

Lines changed: 1 addition & 1 deletion
Loading

docs-site/static/llms.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# @crup/react-timer-hook
22

3-
Reliable React timer lifecycle hooks for timers, schedules, and many independent timers.
3+
React timer lifecycle hooks for timers, schedules, and many independent timers.
44

55
Docs: https://crup.github.io/react-timer-hook/
66
Package: @crup/react-timer-hook
77
Install alpha: npm install @crup/react-timer-hook@alpha
88
Repository: https://github.com/crup/react-timer-hook
99

1010
Public exports:
11-
- useTimer(options): one reliable timer lifecycle.
11+
- useTimer(options): one timer lifecycle.
1212
- useTimerGroup(options): many keyed independent lifecycles with one shared scheduler.
1313
- durationParts(milliseconds): duration display helper.
1414

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@crup/react-timer-hook",
33
"version": "0.0.0",
4-
"description": "Reliable React timer lifecycle hooks for countdowns, stopwatches, schedules, and many independent timers.",
4+
"description": "React timer lifecycle hooks for countdowns, stopwatches, schedules, and many independent timers.",
55
"main": "./dist/index.cjs",
66
"module": "./dist/index.js",
77
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)