Skip to content

Commit 63e6db7

Browse files
authored
Add CHANGELOG and maintainer credit
Document the breaking API and list the fork maintainer in Cargo.toml
1 parent 8b5ac32 commit 63e6db7

3 files changed

Lines changed: 44 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
this project follows [Semantic Versioning](https://semver.org/).
6+
7+
## [Unreleased]
8+
9+
Maintained fork of [euclio/spellbound](https://github.com/euclio/spellbound).
10+
11+
### Breaking
12+
- `Checker::new()` now returns `Result<Self, Error>` instead of panicking when
13+
the spellchecker (or hunspell dictionary) is unavailable
14+
- `SpellingError` now includes UTF-8 byte `start` / `end` offsets into the
15+
checked text (in addition to `text()`)
16+
17+
### Added
18+
- `Error` / `Error::Unavailable`
19+
- Broader Linux dictionary search paths and `en_US` / `en_GB` fallbacks
20+
- Word tokenization with offsets on Unix (alphabetic / `'` runs)
21+
- GitHub Actions CI (Linux, macOS, Windows; fmt; clippy)
22+
- README documentation for the maintained fork and Linux hunspell setup
23+
24+
### Changed
25+
- Edition 2021; dropped `lazy_static` / `extern crate`
26+
- macOS uses `OnceLock` for the shared `NSSpellChecker`
27+
- Windows COM failures map to `Error` where creating the checker; UTF-16
28+
indices convert to UTF-8 byte ranges
29+
30+
### Removed
31+
- Travis CI and APPVeyor configs
32+
33+
## [0.1.1] - 2020-02-05
34+
35+
Last release from upstream (`euclio/spellbound`).

Cargo.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@ categories = ["os", "text-processing"]
66
documentation = "https://docs.rs/spellbound"
77
repository = "https://github.com/rtmongold/spellbound"
88
version = "0.2.0"
9-
authors = ["Andy Russell <arussell123@gmail.com>"]
9+
authors = [
10+
"Andy Russell <arussell123@gmail.com>",
11+
"Robert Mongold <rtmongold@gmail.com>"
12+
]
1013
edition = "2021"
1114
license = "MIT OR Apache-2.0"
1215
readme = "README.md"

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,8 @@ Needs a hunspell dictionary on disk (default search includes `/usr/share/hunspel
4242
Without a dictionary, `Checker::new()` returns `Error::Unavailable`.
4343

4444
## License
45-
MIT OR Apache-2.0
45+
MIT OR Apache-2.0
46+
47+
## Credits
48+
49+
Originally by [Andy Russell](https://github.com/euclio). Maintained in this fork by Robert Mongold.

0 commit comments

Comments
 (0)