Skip to content

Commit 406c510

Browse files
committed
docs(docs): align positioning copy
1 parent 7d671b0 commit 406c510

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

README.md

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

3-
> ~1.2 kB timer core for React, with opt-in batteries for schedules, diagnostics, duration math, and many independent timers.
3+
> A lightweight React hooks library for building timers, stopwatches, and real-time clocks with minimal boilerplate.
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)
@@ -17,7 +17,7 @@
1717

1818
Timer hooks look simple until real apps need pause/resume semantics, Strict Mode cleanup, async callbacks, polling that does not overlap, and lists with dozens of independent timers.
1919

20-
`@crup/react-timer-hook` starts with a tiny core and lets your app compose the heavier pieces only when it needs them:
20+
`@crup/react-timer-hook` starts with a ~1.2 kB timer core and lets your app compose the heavier pieces only when it needs them:
2121

2222
- ⏱️ `useTimer()` from the root package for one lifecycle: stopwatch, countdown, clock, or custom flow.
2323
- 🔋 Batteries are optional: schedules, timer groups, duration helpers, and diagnostics live in subpath imports.

docs-site/docs/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
title: React timer hooks
2+
title: Lightweight React timer hooks
33
slug: /
4-
description: React timer primitives for countdowns, stopwatches, clocks, polling schedules, and many independent timer lifecycles.
4+
description: A lightweight React hooks library for building timers, stopwatches, and real-time clocks with minimal boilerplate.
55
---
66

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

10-
# React timer hooks
10+
# Lightweight React timer hooks
1111

12-
`@crup/react-timer-hook` gives React apps a small root timer primitive and optional subpath hooks for schedules, groups, diagnostics, and duration helpers.
12+
`@crup/react-timer-hook` is a lightweight React hooks library for building timers, stopwatches, and real-time clocks with minimal boilerplate.
1313

14-
It is built for Strict Mode, rerenders, async callbacks, cleanup, and pages with many independent timers.
14+
Start with the ~1.2 kB core hook, then compose opt-in batteries for schedules, diagnostics, duration helpers, and pages with many independent timers.
1515

1616
```sh
1717
npm install @crup/react-timer-hook@alpha

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: 'React timer primitives for real apps.',
11+
tagline: 'Lightweight React hooks for timers, stopwatches, and real-time clocks.',
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: 2 additions & 2 deletions
Loading

docs-site/static/llms.txt

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-
React timer lifecycle hooks for timers, schedules, and many independent timers.
3+
A lightweight React hooks library for building timers, stopwatches, and real-time clocks with minimal boilerplate.
44

55
Docs: https://crup.github.io/react-timer-hook/
66
Package: @crup/react-timer-hook

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": "React timer lifecycle hooks for countdowns, stopwatches, schedules, and many independent timers.",
4+
"description": "A lightweight React hooks library for building timers, stopwatches, and real-time clocks with minimal boilerplate.",
55
"main": "./dist/index.cjs",
66
"module": "./dist/index.js",
77
"types": "./dist/index.d.ts",

0 commit comments

Comments
 (0)