slackdo 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8c46b95ebede93063b5a6654dcb735ec72fbb75
-  data.tar.gz: b711fb41642b659b5f2901ea01224b65a1e30aed
+  metadata.gz: b3bf3dc9d2e78ba03e75ea8a1bb8e0f1f50b859e
+  data.tar.gz: 3c30f6f32cd821a9aa931ff7b2c74b55a1ad2776
 SHA512:
-  metadata.gz: efb5a86913d731950ed77883338728b74818ea2aa56ff96f882aba3eaf6c5c112c0dbc4df158234fdfae5df24cf93478194179989c693c9dd49dbbe4c4fa16be
-  data.tar.gz: 9ee2a74fbaba73dc43f4034894815d1a95d2e9650933ba8a883166276c6f64a93642e7fb6f7ff8aab758fa07e0f632d3e8594cd470e11c60538b72e150b754c9
+  metadata.gz: fbe167ade57ec60275b628a5a812e397dbd724e3e47c1380632288d493068c8b4f231667c87f2180f6d97bf39a866c82f12a351e61b488649e000cba5a26f47c
+  data.tar.gz: 2658a83a948b482526ec031c637f4087f1f87510685351b804569854cd526189fae4bef268790070b0b8cc9d2784e4f07c1c04eb795898a05a0bbbc147832421

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slackdo (0.2.0)
+    slackdo (0.2.1)
       highline
       slack-notifier
 

data/README.md

@@ -1,21 +1,60 @@
 # Slackdo
+![example](img/task-example.png)
+
 SlackDO is a simple CLI tool that allows you to send TODO items and Reminders to yourself on Slack through an incoming webhook.
 
 ## Installation
 
-```ruby
+```
 gem install slackdo
 ```
 
+In order to use slackdo you still have to add the rubygem's bin location to your $PATH.
+
+eg. for OSX:
+
+```bash
+export PATH=$PATH:/usr/local/lib/ruby/gems/2.4.0/gems/slackdo-0.2.0/bin
+```
+
+To get to know your general gem installation path use the following for your general rubygems information and look for the GEM PATHS variable:
+
+```bash
+$ gem env
+```
+
+Or just check the specific gem information to see the location where it's installed:
+
+```bash
+$ gem which slackdo
+/usr/local/lib/ruby/gems/2.4.0/gems/slackdo-0.2.0/lib/slackdo.rb
+```
+
+This indicates that your gem binary is located at `/usr/local/lib/ruby/gems/2.4.0/gems/slackdo-0.2.0/bin`.
+
 ## Usage
 
-First thing you should do is configure your incoming webhook by doing `slackdo webhook`.
+First thing you should do is configure your incoming webhook by doing the following:
+
+```
+slackdo webhook
+```
+
+After that you're all set to go.
+Add a new TODO item by using
 
-After that you're all set to go. Add a new TODO item by typing `slackdo task` or add a reminder with `slackdo reminder`.
+```ruby
+slackdo task
+```
+or add a reminder with
+
+```ruby
+slackdo reminder
+```
 
 ## Development
 
-Slackdo is still under development and might still be buggy. Feel free to add support to the project.
+Slackdo is still under development and might still be buggy. Feel free to contribute to the project.
 
 ## Contributing
 

data/lib/slackdo/version.rb

@@ -1,3 +1,3 @@
 module Slackdo
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/slackdo.rb

@@ -5,7 +5,7 @@ require 'slack-notifier'
 module Slackdo
   class Webhook
 	def create_directory
-	  system 'mkdir ~/.slackdo'
+	  system 'mkdir ~/.slackdo &> /dev/null'
 	end
 	def configure_webhook
 	  cli = HighLine.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackdo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - segersniels
@@ -88,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -99,6 +100,7 @@ files:
 - bin/console
 - bin/setup
 - bin/slackdo
+- img/task-example.png
 - lib/slackdo.rb
 - lib/slackdo/version.rb
 - slackdo.gemspec