https://github.com/sprql/dictionary_kit
Dictionary Kit
https://github.com/sprql/dictionary_kit
Last synced: about 1 year ago
JSON representation
Dictionary Kit
- Host: GitHub
- URL: https://github.com/sprql/dictionary_kit
- Owner: sprql
- License: mit
- Created: 2017-01-01T21:18:22.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-31T20:53:20.000Z (over 9 years ago)
- Last Synced: 2025-03-22T20:14:18.443Z (over 1 year ago)
- Language: Elixir
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DictionaryKit
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `dictionary_kit` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:dictionary_kit, "~> 0.1.0"}]
end
```
## Usage
```elixir
source_data = File.read!("source.txt")
# => "Brave New World..."
known_words = File.read!("known_words.txt")
# => "world brave..."
dictionary = File.read!("/usr/share/dict/words")
# => "a apple..."
DictionaryKit.find_unknown_words(source_data, known_words, dictionary)
# => ["new"]
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/dictionary_kit](https://hexdocs.pm/dictionary_kit).