Sha256: af7757bb937ca9053c81f8e27bcfa994bf4074eae2f0ca52e71fbc509cfa6a4e

Contents?: true

Size: 1.95 KB

Versions: 3

Compression:

Stored size: 1.95 KB

Contents

# Weasel

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/weasel`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'weasel'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install weasel

## Usage

First, you'll need to create a table like this:

```ruby
class AddWeaselTables < ActiveRecord::Migration
  def self.up
    create_table :weasel_events do |t|
      t.integer :actor_id
      t.string  :actor_type
      t.text    :action_data

      t.timestamps
    end

    def self.down
      drop_table :weasel_events
    end
  end
end
```

Then, create an initializer to configure Weasel. Put this in it:

```ruby
Weasel.configure do |config|
  config.db_configuration = ActiveRecord::Base.connection_config
end
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/goodpeople/weasel. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
weasel-0.2.2 README.md
weasel-0.2.1 README.md
weasel-0.2.0 README.md