README.md in PackingPeanut-0.0.2 vs README.md in PackingPeanut-0.0.3

- old
+ new

@@ -1,6 +1,6 @@ -# ![PackingPeanut Logo](./_art/logo_100.png) PackingPeanut +# ![PackingPeanut Logo](./_art/logo_100.png) PackingPeanut [![Gem Version](https://badge.fury.io/rb/PackingPeanut.svg)](http://badge.fury.io/rb/PackingPeanut) iOS has [BubbleWrap](https://github.com/rubymotion/BubbleWrap) for App Persistence : Android has PackingPeanut There is a sedulous effort to make this syntax fit BubbleWrap's as much as possible, but differences simply exist, either for good, technical, or sometimes diabolical reasons :smiling_imp: @@ -16,12 +16,18 @@ $ bundle ## Usage -Example Usage from REPL +**It's as simple as:** +```ruby +App::Persistence[:foo] = true +# App::Persistence[:foo] would now return true ``` + +Whirlwind Tour via the REPL +``` # PP automatically has context if the module is included # In this case we need to set the context $ App::Persistence.context = self => #<MainActivity:0x1d20058e> $ App::Persistence['dinner'] = "nachos" @@ -36,15 +42,15 @@ => "some_new_file" $ App::Persistence['dinner'] => "" # empty because we're now outside the default storage file. $ App::Persistence.preference_mode = :world_readable => :world_redable - +$ PP::Persistence['some_boolean'] = true #You can use PP instead of App if you like ``` -`App::Persistence` has been Aliasted to `PP::Persistence` for the bold. + ## What are preference modes? Preference Modes are ANdroid Operating modes. Use 0 or MODE_PRIVATE for the default operation, MODE_WORLD_READABLE and MODE_WORLD_WRITEABLE to control permissions. The bit MODE_MULTI_PROCESS can also be used if multiple processes are mutating the same SharedPreferences file. MODE_MULTI_PROCESS is always on in apps targeting Gingerbread (Android 2.3) and below, and off by default in later versions. Memorizable symbols and their corresponding constants: @@ -59,10 +65,13 @@ multi_process: MODE_MULTI_PROCESS } ``` ## Limitations? -Achilles, the Death Star, and video game villians always have a significant catch. As of right now, you can only store strings, ints, and booleans. The data is serialized, and should support hashes, arrays, and floats but alas, I claim there be bugs in conversions via RM Android. +Achilles, the Death Star, and video game villians always have a significant catch. As of right now, you can only store **strings, ints, and booleans**. The data is serialized, and should support hashes, arrays, and floats but alas, I claim there be bugs in conversions via RM Android. + +## Tests? +Boy that would be nice wouldn't it? ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)