README.md in ffi-hunspell-0.5.0 vs README.md in ffi-hunspell-0.6.0
- old
+ new
@@ -3,19 +3,18 @@
* [Source](https://github.com/postmodern/ffi-hunspell)
* [Issues](https://github.com/postmodern/ffi-hunspell/issues)
* [Documentation](http://rubydoc.info/gems/ffi-hunspell/frames)
* [Email](postmodern.mod3 at gmail.com)
-[![Build Status](https://secure.travis-ci.org/postmodern/ffi-hunspell.png?branch=master)](https://travis-ci.org/postmodern/ffi-hunspell)
-
## Description
Ruby FFI bindings for [Hunspell][libhunspell].
## Examples
Open a dictionary:
+
```rb
require 'ffi/hunspell'
FFI::Hunspell.dict do |dict|
# ...
@@ -29,39 +28,47 @@
# ...
dict.close
```
Check if a word is valid:
+
```rb
dict.check?('dog')
# => true
dict.check?('d0g')
# => false
```
+
Find the stems of a word:
+
```rb
dict.stem('dogs')
# => ["dog"]
```
+
Suggest alternate spellings for a word:
+
```rb
dict.suggest('arbitrage')
# => ["arbitrage", "arbitrages", "arbitrager", "arbitraged", "arbitrate"]
```
+
## Requirements
-* [libhunspell] >= 1.2.0
+* [libhunspell] >= 1.2.0, <= 1.7.0
* [ffi] ~> 1.0
## Install
+
```sh
$ gem install ffi-hunspell
```
+
## License
-Copyright (c) 2010-2016 Hal Brodigan
+Copyright (c) 2010-2020 Hal Brodigan
See {file:LICENSE.txt} for license information.
-[libhunspell]: http://hunspell.sourceforge.net/
+[libhunspell]: http://hunspell.github.io/
[ffi]: https://github.com/ffi/ffi