tiny-redis 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10fdb8684fc3377ed6c516b0c07d4ecfe77d3ecd07893b04aff36e6ebe7ee7f
-  data.tar.gz: 8669162c0bfd1c8edd0e2779b9daac9dbc1600fa785751d3059de716449674c5
+  metadata.gz: bd6a84939fe1d2708c7002aadbb81ce0be8d80c89bcd5a004f27dd4a71bb7959
+  data.tar.gz: 0e794200b037b8317420415445872a30964b285528514c62ded17d1b1d9a43ec
 SHA512:
-  metadata.gz: 4fca70d1889a3f7b7da86eaf8e245fea77af710f5d3a4865d1320b47b9ae62dec776209386d5823b5ce31c01104c62e52861d13e5114f368f8678ba26f419c3b
-  data.tar.gz: 45e7cb8bb66c998201f605dba108768a059dc15bc066adf1b9a0eda96fcae975ad76080ce70b4524f0ddd6e742df73e17dc3a3e3ed9d332cadb03f5a1ffa00ca
+  metadata.gz: 1e46955cce74ffe344565f059987446dd274bf9736290bb462a3348bb935c69670f22dac777364cb48679c6d84e6dc6379a035e49fc1b9a217d1f75e010f2ac8
+  data.tar.gz: e1583b64114d166feefab1d59ad0df457ae6ed0c34307ad266328754781d4a9229ab39e3b7cb732debc3a8f477a904447b75ea20e2ec030122c7706bd7de2f6b

data/README.md

@@ -1,28 +1,39 @@
-# Tiny::Redis
-Short description and motivation.
+### tiny-redis
 
-## Usage
-How to use my plugin.
+Tiny Redis - encrypted barebones JSON formatted orm.
+Encryption is Rails Credentials based.
 
-## Installation
-Add this line to your application's Gemfile:
+Steps to use:
+```
+   add to Gemfile:
+   gem 'tiny-redis'
+
+   bundle install
 
-```ruby
-gem 'tiny-redis'
+   rails g tiny_redis
+
+   this will install initalizer that creates a pool of redis connections
 ```
 
-And then execute:
-```bash
-$ bundle
+## How to use
+
+```
+   class User
+   include TinyRedis
+
+   attr_accessor :email
+   alias_method :index, :email # this will tie your records method to indexing parameter
+   end
+```
+Set up credentials:
 ```
+   rails credentials:edit --environment development
 
-Or install it yourself as:
-```bash
-$ gem install tiny-redis
+   add:
+   user:
+     encryptkey: abcdabcdabcdadbvabcdabcdabcdadbv
 ```
 
-## Contributing
-Contribution directions go here.
+Now your records in redis are encrypted. If you wish for more security you can remove config/master.key after server starts. And investigate SE Linux address space protection so hacker can't pry encryption key from the app so easily.
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Have fun! 🎉

data/lib/tiny/redis/version.rb

@@ -1,5 +1,5 @@
 module Tiny
   module Redis
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tiny-redis
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Pavel Zaitsev