diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d5315a5 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,35 @@ +# Changelog + +All notable changes to this project are documented in this file. + +this project follows [Semantic Versioning](https://semver.org/). + +## [Unreleased] + +Maintained fork of [euclio/spellbound](https://github.com/euclio/spellbound). + +### Breaking +- `Checker::new()` now returns `Result` instead of panicking when + the spellchecker (or hunspell dictionary) is unavailable +- `SpellingError` now includes UTF-8 byte `start` / `end` offsets into the + checked text (in addition to `text()`) + +### Added +- `Error` / `Error::Unavailable` +- Broader Linux dictionary search paths and `en_US` / `en_GB` fallbacks +- Word tokenization with offsets on Unix (alphabetic / `'` runs) +- GitHub Actions CI (Linux, macOS, Windows; fmt; clippy) +- README documentation for the maintained fork and Linux hunspell setup + +### Changed +- Edition 2021; dropped `lazy_static` / `extern crate` +- macOS uses `OnceLock` for the shared `NSSpellChecker` +- Windows COM failures map to `Error` where creating the checker; UTF-16 + indices convert to UTF-8 byte ranges + +### Removed +- Travis CI and APPVeyor configs + +## [0.1.1] - 2020-02-05 + +Last release from upstream (`euclio/spellbound`). \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml index 1b24c2d..bce7e25 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,10 @@ categories = ["os", "text-processing"] documentation = "https://docs.rs/spellbound" repository = "https://github.com/rtmongold/spellbound" version = "0.2.0" -authors = ["Andy Russell "] +authors = [ + "Andy Russell ", + "Robert Mongold " +] edition = "2021" license = "MIT OR Apache-2.0" readme = "README.md" diff --git a/README.md b/README.md index b5a78f9..7e7ab4b 100644 --- a/README.md +++ b/README.md @@ -42,4 +42,8 @@ Needs a hunspell dictionary on disk (default search includes `/usr/share/hunspel Without a dictionary, `Checker::new()` returns `Error::Unavailable`. ## License -MIT OR Apache-2.0 \ No newline at end of file +MIT OR Apache-2.0 + +## Credits + +Originally by [Andy Russell](https://github.com/euclio). Maintained in this fork by Robert Mongold. \ No newline at end of file