meiou 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffaee59e725de71fe02e8172475790aad75e79a26e99382eda714dc339983798
-  data.tar.gz: 9461f7eebafcc7a28e12f59883910cf7644f1b3d8b01e5ced737968b85196e9c
+  metadata.gz: 4ed7883fc4710608f63e64ecac68d66866ad1fa9376cb8f8ae84749a0b69cd0b
+  data.tar.gz: ac84de1e6b1409646f439e5b97ca8599584cdf3d356245c6bec202a48c4babc5
 SHA512:
-  metadata.gz: 111be57c597ab493422a48bbd3eb00dcbb941a2b62f0a43882d8a299611a83608f25abd5ab47772dd2e9560ba48df38ddabda118eed5f9200173cf9bde09aeaa
-  data.tar.gz: 70898d2927f4c5f317011cd8e00ab02bd420811c84c2e31f928df3511dc0bd94a546ff1f7bbe65f80ff3170e9ce839f72c5d46aa1015c6c94e83f7fd84371a23
+  metadata.gz: 5bba40f60cb326e847f7330a449034f7f7be444116da85bac01beae6a61ae2fd87d402eff3189db502efa58b24ef35b8db5f8daf95fa3a5ef9d559c3786b9e41
+  data.tar.gz: e2c4e7dd446dfba6939f4d385fdeb66e35332ea6c44497e4663f2629d391d9e3a62b7d87090fea7e9c5a226771664f11623079eda19dc545a4e4315bdb760681

data/README.md

@@ -1,39 +1,26 @@
 # Meiou
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/meiou`. To experiment with that code, run `bin/console` for an interactive prompt.
+Used to find keywords in input text and return context about those keywords.
 
 ## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
+### bundle
+```
+bundle add meiou
+```
+### gems
+```
+gem install meiou
+```
 ## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/meiou. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/meiou/blob/master/CODE_OF_CONDUCT.md).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Meiou project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/meiou/blob/master/CODE_OF_CONDUCT.md).
+### basic
+```
+Mieou["What is the meaning of life?"]
+```
+### custom
+First, create the "books/" directory in your project.
+Then include txt files with the necessary pieces of information.
+Finally you can do the following:
+```
+Meiou.compile!
+```
+Then you can use as normal, but also giving references to given text snippets.