mr_clean 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 981783c05ef0ee3efaa39108535ce765ed5c0c5d
-  data.tar.gz: f07f65fbf197fd22678c0ea304b2ffcc2b0ce4db
+  metadata.gz: dd7d36f963b96d66204e9a3be636393c123f0fa4
+  data.tar.gz: e58da933f3c60e1a0e9f76d03dfb6a4fcd3b7daa
 SHA512:
-  metadata.gz: 816d8cee2ff30af48834011f9d3450a9e7457e8a4749808b0b3fe757794e150cb85f5da7b8c3695a1634a137284793d59bd1dfb5d8a0e66b88528d142cbd1c55
-  data.tar.gz: 2e6dfc7e359f9263c711c9e004640b37c5e3353f05e990a34468642511d1f6320810da705d4ea36f978bea025dcbc1e5376f5e1409ed895183821a047db74391
+  metadata.gz: 0ac4ec944ae1e506454c83041db964c98c0c8b7fcc98118d1faa9f0f8730255e8f3a5cad81314343af7f57fff1ab6f8080f581634bd3d7f88795b6c156beaf22
+  data.tar.gz: 7cdc2c3f3a583b28fb2c972e61f20331bd433c054e0a09b9684fd67b7b3c91f473f95cd0a0b2bb3351a32d9fb484413b98b309ac6be4a001125e9346d705856d

data/README.md

@@ -2,3 +2,42 @@ Mr Clean
 ========
 
 A plain ruby library for filtering profanity, spam and such based on black listed words
+
+## Installation
+
+### Gemfile
+
+Add `mr_clean` to your Gemfile:
+
+```ruby
+gem 'mr_clean'
+```
+
+And run Bundler:
+
+```sh
+$ bundle install
+```
+
+### Manually:
+
+Or install `mr_clean` manually:
+
+```sh
+$ gem install 'mr_clean'
+```
+
+And require the gem in your Ruby code:
+
+```ruby
+require 'rubygems'
+require 'mr_clean'
+```
+
+Usage
+=====
+
+To check if a string value contains profane or spam words:
+  ```ruby
+  MrClean::Profanity.profane?(value)
+  ```

data/lib/mr_clean/version.rb

@@ -1,3 +1,3 @@
 module MrClean
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mr_clean
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - CrunchBase Engineering Team, Wagner Camarao