README.md in voyageai-0.1.0 vs README.md in voyageai-1.0.0

- old
+ new

@@ -18,27 +18,14 @@ 'Paul is a plumber.', 'George is a teacher.', 'Ringo is a doctor.', ] -voyage_ai = VoyageAI::Client.new(api_key: 'pa-...') -result = voyage_ai.embed(input) +voyageai = VoyageAI::Client.new(api_key: 'pa-...') # or configure ENV['VOYAGEAI_API_KEY'] + +result = voyageai.embed(input) embed.model # "..." embed.usage # "#<VoyageAI::Usage total_tokens=...>" embed.embeddings.each do |embedding| - embedding # "#<VoyageAI::Embedding index=... embedding=...> + embedding.index # "#<VoyageAI::Embedding index=... embedding=...> end ``` - -## Development - -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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]/voyageai. - -## License - -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).