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/squongo
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Add this line to your application's Gemfile:
gem 'squongo'
And then execute:
$ bundle
Or install it yourself as:
$ gem install squongo
require 'squongo'
class Post < Squongo::Document
TABLE = :posts
end
Squongo.connect('somefile.db')
Squongo.start_writer
post = Post.new title: 'example', text: 'lorem ipsum'
post.save
other_post = Post.find(1)
other_post.data = { title: 'New Example' }
other_post.save
title_post = Post.find_by title: 'New Example'
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 tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/squongo.