cefr-words 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e74164fda49eb142d16d8fdda31634fd95e6b31a0211d215ee1d1607745d17c0
+  data.tar.gz: 45808906dffba35741d5540953db06b48089dcc8d1ecd762ae44a49e10c0033a
+SHA512:
+  metadata.gz: 63252ce7e1e87caf5c5d934772a03d6d0f2ee25aa2b7afe350a2bca049afd33afbd01b39b6112c4eee7c13cd139600f7f400b5212870b9f61ab011b2fa9870cf
+  data.tar.gz: b7248dc86414e80c765a7e582fdc1950b427bdc60b201bee82fcec14f88bcff418b1c83628296bd4a0cafdd57319a3450d999552ba78efc5e8e2628987235f93

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2022] [datpmt]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# CEFR Levels Words
+
+A gem that provides English vocabulary lists organized by CEFR levels.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cefr-words'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+To get words with CEFR level:
+```ruby
+word_list = CefrWords::WordList.new
+
+# Get A1 words
+word_list.words_by_level("a1")
+
+# Get A1-C1 words
+word_list.words_by_level("all")
+```
+
+## Contributors
+
+- [datpmt](https://github.com/datpmt)
+
+I welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b your-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin your-feature`).
+5.  Create a new pull request.
+
+## References
+1. https://www.oxfordlearnersdictionaries.com/external/pdf/wordlists/oxford-phrase-list/Oxford%20Phrase%20List.pdf
+2. https://www.oxfordlearnersdictionaries.com/external/pdf/wordlists/oxford-3000-5000/The_Oxford_3000_by_CEFR_level.pdf
+
+## License
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/lib/cefr-words.rb

@@ -0,0 +1,7 @@
+require_relative 'cefr_words/version'
+require_relative 'cefr_words/word_list'
+
+# A gem that provides English vocabulary lists organized by CEFR levels.
+
+module CefrWords
+end