lita-reddit-image 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44021ae429198786e877dfb842264593cf14370871aa8b783e4f34c9ea9444da
-  data.tar.gz: 3beba85ced69c47d9d969c05db6e3c57f582571e94948f3a112db47fb2c20c28
+  metadata.gz: 549cba4775ad2765b59ea02a2f7d986483e9cf1815e2e807cff01cbb2134f064
+  data.tar.gz: d2c3610f8aceff5760cc5e87427ae3781eec7679da7250d771bbbcdcf83307e3
 SHA512:
-  metadata.gz: bc0164958fa0b524252efe9f600728b44bfdf0d1ad522da35f2857f235f6ff413e88eac720bd974d76890b139b51eade978c5ffb9e4ebd3232642ce48fe17134
-  data.tar.gz: 79745eae1e7140f3437df3cfbced982013016b4127e2bec97562aec0413cc79e0e9378a84cd7ae792f30ae3ccc54995ee293a7159e2c3af05dd0ce12bdeb197d
+  metadata.gz: e9ebbc8db996fd979c173d956bc428d694406b1ba6878e7f138b45981ceb32d0cb73611569eb1a010ff0f4a665331ef69f71271c5fe382c784fba42edc104a5c
+  data.tar.gz: 4e6321a172bdb2d10217c133ed42538025950f821d9566b2a0eced6946b44b5a5c510363ca89f674d243b3a03c60895d17537a16759d23e6ec014dad51cf1715

data/README.md

@@ -1,8 +1,6 @@
 # lita-reddit-image
 
-Lita handler for querying images from Reddit
-
-TODO: Add a description of the plugin.
+Lita handler for querying images from Reddit.
 
 ## Installation
 
@@ -14,8 +12,28 @@ gem "lita-reddit-image"
 
 ## Configuration
 
-TODO: Describe any configuration attributes the plugin exposes.
+Only 2 required parameters:
+* Your Reddit username
+* Your Reddit App Id
+
+Create a new Reddit App and get an App Id.
+
+Your username is used in the User-Agent headers for querying the Reddit API, as
+requested by Reddit developers.
+
+```ruby
+Lita.configure do |config|
+  config.handlers.reddit_image.app_id = "reddit_developer_app_id"
+  config.handlers.reddit_image.username = "reddit_username"
+end
+```
 
 ## Usage
 
-TODO: Describe the plugin's features and how to use them.
+Use the following syntax: `/r/[subreddit] [query]` to fetch an image from Reddit.
+
+Ex. Get a nice happy bunny from /r/aww 🐇
+
+```
+Lita /r/aww Bunny
+```

data/lib/lita/handlers/reddit_image.rb

@@ -37,6 +37,7 @@ module Lita
           sleep 0.5
         rescue StandardError => e
           Lita.logger.warn("Couldn't fetch image from Reddit: " + e.message)
+          response.reply("I couldn't fetch an image from Reddit.")
         end
       end
 

data/lib/lita/handlers/reddit_image/version.rb

@@ -3,7 +3,7 @@ require 'lita'
 module Lita
   module Handlers
     class RedditImage < Handler
-      VERSION = '0.1.0'.freeze
+      VERSION = '0.1.1'.freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-reddit-image
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Maxime 'biximilien' Gauthier