Skip to content

Commit 24f6e8d

Browse files
committed
chore: tweak READMEs
1 parent 06806d9 commit 24f6e8d

File tree

2 files changed

+34
-11
lines changed

2 files changed

+34
-11
lines changed

packages/topojson-schema/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,26 @@ Geometry schemas:
1616
- [MultiLineString](https://sruenwg.github.io/topojson-validation/schemas/draft-07/MultiLineString.json)
1717
- [Polygon](https://sruenwg.github.io/topojson-validation/schemas/draft-07/Polygon.json)
1818
- [MultiPolygon](https://sruenwg.github.io/topojson-validation/schemas/draft-07/MultiPolygon.json)
19-
- [Null Object](https://sruenwg.github.io/topojson-validation/schemas/draft-07/NullObject.json)
20-
- [Geometry Collection](https://sruenwg.github.io/topojson-validation/schemas/draft-07/GeometryCollection.json)
21-
- [Geometry Objects](https://sruenwg.github.io/topojson-validation/schemas/draft-07/GeometryObject.json)
19+
- [NullObject](https://sruenwg.github.io/topojson-validation/schemas/draft-07/NullObject.json)
20+
- [GeometryCollection](https://sruenwg.github.io/topojson-validation/schemas/draft-07/GeometryCollection.json)
21+
- [GeometryObject](https://sruenwg.github.io/topojson-validation/schemas/draft-07/GeometryObject.json)
2222

2323
Other schemas:
24-
- [Arc Indexes](https://sruenwg.github.io/topojson-validation/schemas/draft-07/ArcIndexes.json)
24+
- [ArcIndexes](https://sruenwg.github.io/topojson-validation/schemas/draft-07/ArcIndexes.json)
2525
- [Arcs](https://sruenwg.github.io/topojson-validation/schemas/draft-07/Arcs.json)
26-
- [Bounding Boxes](https://sruenwg.github.io/topojson-validation/schemas/draft-07/Bbox.json)
26+
- [Bbox](https://sruenwg.github.io/topojson-validation/schemas/draft-07/Bbox.json)
2727
- [Objects](https://sruenwg.github.io/topojson-validation/schemas/draft-07/Objects.json)
2828
- [Position](https://sruenwg.github.io/topojson-validation/schemas/draft-07/Position.json)
29-
- [TopoJSON Objects](https://sruenwg.github.io/topojson-validation/schemas/draft-07/TopoJsonObject.json)
29+
- [TopoJsonObject](https://sruenwg.github.io/topojson-validation/schemas/draft-07/TopoJsonObject.json)
3030
- [Transform](https://sruenwg.github.io/topojson-validation/schemas/draft-07/Transform.json)
3131

3232

3333
## Usage
3434

35-
To use the schemas, either install the package from npm (`npm install @sruenwg/topojson-schema`) or fetch the schemas from the links above.
35+
To use the schemas, either install the package via `npm install @sruenwg/topojson-schema` or fetch the schemas from the links above.
3636
Make sure your validator supports JSON Schema draft-07.
3737

38-
For instance, using Ajv:
38+
Example using Ajv:
3939
```ts
4040
import Ajv from 'ajv';
4141
import { Topology as installedSchema } from '@sruenwg/topojson-schema/draft-07';
@@ -61,4 +61,4 @@ isTopology = ajv.validate(fetchedSchema, myTopology);
6161

6262
Some requirements of the TopoJSON specification are not fully validated by these schemas, in part due to the difficulty of performing complex validation via JSON Schema.
6363

64-
See the tests in the `test` folder (alongside the [`topojson-tests`](https://github.com/sruenwg/topojson-validation/tree/main/packages/topojson-tests) package which the tests rely on) for details on what cases are/aren't handled.
64+
See the [`test`](https://github.com/sruenwg/topojson-validation/tree/main/packages/topojson-schema/test) folder (along with the [`topojson-tests`](https://github.com/sruenwg/topojson-validation/tree/main/packages/topojson-tests) package which the tests rely on) for details on what cases are/aren't handled.

packages/topojson-valibot/README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,33 @@ This package provides [Valibot](https://valibot.dev/) schemas for validating [To
44

55
Schemas and their inferred types are provided for each constituent part of the TopoJSON format.
66

7+
Main schema:
8+
- Topology
9+
10+
Geometry schemas:
11+
- Point
12+
- MultiPoint
13+
- LineString
14+
- MultiLineString
15+
- Polygon
16+
- MultiPolygon
17+
- NullObject
18+
- GeometryCollection
19+
- GeometryObject
20+
21+
Other schemas:
22+
- ArcIndexes
23+
- Arcs
24+
- Bbox
25+
- Objects
26+
- Position
27+
- TopoJsonObject
28+
- Transform
29+
730

831
## Usage
932

10-
Simply use the schemas like any other Valibot schema.
33+
Simply use the schemas like any Valibot schema.
1134
```ts
1235
import * as v from 'valibot';
1336
import { TopologySchema } from '@sruenwg/topojson-valibot';
@@ -34,4 +57,4 @@ function truncateDimensions(pos: Position) {
3457

3558
Some requirements of the TopoJSON specification are not fully validated by these schemas.
3659

37-
See the tests in the `test` folder (alongside the [`topojson-tests`](https://github.com/sruenwg/topojson-validation/tree/main/packages/topojson-tests) package which the tests rely on) for details on what cases are/aren't handled.
60+
See the [`test`](https://github.com/sruenwg/topojson-validation/tree/main/packages/topojson-valibot/test) folder (along with the [`topojson-tests`](https://github.com/sruenwg/topojson-validation/tree/main/packages/topojson-tests) package which the tests rely on) for details on what cases are/aren't handled.

0 commit comments

Comments
 (0)