Skip to content

Commit 45fb4e6

Browse files
committed
docs: fix README accuracy
1 parent 974b09c commit 45fb4e6

3 files changed

Lines changed: 21 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com), and this
66
project adheres to [Semantic Versioning](https://semver.org).
77

8+
## [2.0.1] - 2026-04-09
9+
10+
### Fixed
11+
12+
- Documented `PromotionPieceType` type export and corrected `Move` type
13+
documentation — `Move` is defined locally (not re-exported from
14+
`@echecs/position`) and has a `promotion?: PromotionPieceType` field.
15+
816
## [2.0.0] - 2026-04-09
917

1018
### Changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,20 @@ interface SanMove {
6969
`file` and `rank` are the disambiguation hints from the SAN string, not the
7070
destination square. `to` is `undefined` for castling moves.
7171

72-
`Move` and `Position` are re-exported from `@echecs/position`:
72+
`Move` is defined locally in `@echecs/san`:
7373

7474
```typescript
75-
import type { Move, Position } from '@echecs/san';
75+
interface Move {
76+
from: Square;
77+
promotion?: PromotionPieceType;
78+
to: Square;
79+
}
80+
```
81+
82+
`Position` is re-exported from `@echecs/position` for convenience:
83+
84+
```typescript
85+
import type { Move, Position, PromotionPieceType } from '@echecs/san';
7686
```
7787

7888
## Errors

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,5 @@
7474
},
7575
"type": "module",
7676
"types": "dist/index.d.ts",
77-
"version": "2.0.0"
77+
"version": "2.0.1"
7878
}

0 commit comments

Comments
 (0)