<commit_before>Riik
====

Lightweight object mapper for Riak.

Usage 
=====

Specify a class and include the object mapper mixin.  Then, specify the
argument list for the initialize method.

```ruby 
class Person
  include Riik::Document
  initializes_with :first_name, :last_name
end

```

Then, use it!

```ruby 
Person.find('this-key-name')  # => #<Person.. @first_name="Fat", @last_name="Mike">
p = Person.new('Fat', 'Mike') # => #<Person.. @first_name="Fat", @last_name="Mike">
p.save # => true
```

Customization 
=============
<commit_msg>Add more information into the README.<commit_after>Riik
====

Lightweight object mapper for Riak.

Motivation
==========

Riik doesn't support everything you would exepct from a full ORM.  There
are no validations, no callbacks, etc,.  as the primary motivation was
providing an extremely thin abstraction over RObject allowing you to map
classes and object to serialized keys.  The benefits come from being
able to work with a lightweight abstraction without dependencies on
larger, external gems, such as activesupport and activemodel.

If you're building an entire site with Riak as the primary data store,
you should be looking at [Ripple]{https://github.com/seancribbs/ripple}.

Usage 
=====

Specify a class and include the object mapper mixin.  Then, specify the
argument list for the initialize method.

```ruby 
class Person
  include Riik::Document
  initializes_with :first_name, :last_name
end

```

Then, use it!

```ruby 
Person.find('this-key-name')  # => #<Person.. @first_name="Fat", @last_name="Mike">
p = Person.new('Fat', 'Mike') # => #<Person.. @first_name="Fat", @last_name="Mike">
p.save # => true
```

Customization 
=============

{'fraction_non_alphanumeric': 0.13991769547325103, 'fraction_numerical': 0.0, 'mean_word_length': 4.808873720136519, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 13, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1822596', 'n_tokens_mistral': 562, 'n_tokens_neox': 522, 'n_words': 190}