@road-signs/react 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +32 -0
  3. package/package.json +2 -2
package/CHANGELOG.md ADDED
@@ -0,0 +1,14 @@
1
+ # @road-signs/react
2
+
3
+ ## 0.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - f798cfd: Add a README to every package, so the npm page for each one documents what it
8
+ contains and how to use it instead of rendering blank.
9
+
10
+ Country READMEs are generated from the same metadata that drives the docs site
11
+ plus live counts read from each registry, so they cannot drift from the code.
12
+
13
+ - Updated dependencies [f798cfd]
14
+ - @road-signs/core@0.1.1
package/README.md ADDED
@@ -0,0 +1,32 @@
1
+ # @road-signs/react
2
+
3
+ Accessible React component for road signs — works with any country package.
4
+
5
+ ## Install
6
+
7
+ ```sh
8
+ npm install @road-signs/react
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```ts
14
+ import { getSign } from '@road-signs/us';
15
+ import { RoadSign } from '@road-signs/react';
16
+
17
+ const sign = getSign('w1-1r-turn-right')!;
18
+
19
+ <RoadSign sign={sign} size={64} />;
20
+ ```
21
+
22
+ Every sign renders from its country package alone — the artwork is inline
23
+ SVG, with the accessible name and description injected into it automatically.
24
+
25
+ ## Links
26
+
27
+ - [Documentation](https://karlnorling.github.io/road-signs)
28
+ - [Source](https://github.com/karlnorling/road-signs/tree/main/packages/@road-signs/react)
29
+
30
+ ## License
31
+
32
+ MIT © Karl Norling
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@road-signs/react",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "Accessible React components for road signs — works with any @road-signs/* country package",
5
5
  "keywords": [
6
6
  "react",
@@ -36,7 +36,7 @@
36
36
  "type-check": "tsc --noEmit -p tsconfig.json"
37
37
  },
38
38
  "dependencies": {
39
- "@road-signs/core": "0.1.0"
39
+ "@road-signs/core": "0.1.1"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@types/jest": "^30.0.0",