uvcli 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 353ed54e36ae32b3df177e0049506e04f60a3b6f
-  data.tar.gz: fd389bd0d3978eae204ec043b0215782e915cf16
+  metadata.gz: 3f2123b65a58279da3fd7aa6e17c120bdd5c1805
+  data.tar.gz: e8a4251b81e32a5fc2a17db457572202e2a4336e
 SHA512:
-  metadata.gz: 0ffb0c223bca5463222404511b44a3cb094920a8bc2fde0f93628bae608404ebb21991f906c8afd854468d20efeeb3f5c7610439d8e3305ee068e89f765a31c6
-  data.tar.gz: 1943d4fc3ac787c293a2f276c4d62801783790b18e0de8f5f4593dd5f8bf2024fbc52bb277164da91735e070b486cb543f020407f98adb54f367b82bee9a549c
+  metadata.gz: ad68de32bfd3941b2e5441947dd4d6650a83d9f052ae0726c9d298e518b29b2f5d3ce5d497103c9ddf8c3f1286cc2d66f53892b2656230daecb7f07afe14afd9
+  data.tar.gz: 90813f54204d6e33fc6c5e6eb7f6303864b6a5426a0f7da2925a8a8b6ca2e3075372d63642a54e9d6677618ad459a0d2022a8dcead44064b15b68b421d534d4f

data/README.md

@@ -1,30 +1,42 @@
 # Uvcli
 
-Uvcli is a command line interface for the UserVoice support and feedback platform.
+Uvcli is a command line interface for the [UserVoice](https://www.uservoice.com) support and feedback platform.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Open a terminal window and install uvcli.
 
-```ruby
-gem 'uvcli'
-```
+    $ gem install uvcli
 
-And then execute:
+## Usage
 
-    $ bundle
+Uvcli takes two commands `login` and `check`.
 
-Or install it yourself as:
+![Uvcli commands](https://github.com/dangercove/uvcli/raw/master/screenshots/commands.jpg)
 
-    $ gem install uvcli
+### Login
 
-## Usage
+Add new UserVoice sites to your configuration by running:
+
+    $ uvcli login
+
+It'll prompt you for the site's domain, key and secret. To get a key and secret go into __UserVoice → Settings → Integrations → UserVoice API keys__ and click __Add API Key...__ Make sure you set the API key to __TRUSTED__.
+
+### Check
+
+Uvcli will loop through each site that you've setup and look for open tickets. Afterwards you can tell uvcli to open a single ticket or all of them in your default browser.
+
+    $ uvcli check 
+
+![Uvcli tickets](https://github.com/dangercove/uvcli/raw/master/screenshots/tickets.jpg)
+
+### Removing sites
 
-TODO: Write usage instructions here
+You can manually remove sites from the configuration file, located in `~/.uvcli/uvcli.yml`.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/uvcli/fork )
+1. Fork it ( https://github.com/dangercove/uvcli/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/uvcli/cli.rb

@@ -8,7 +8,7 @@ module Uvcli
      
       @@settings = Uvcli::Settings.new
 
-      desc "login", "Login to an existing UserVoice account."
+      desc "login", "Login to an existing UserVoice account"
       def login
         puts %{\nTo login to your UserVoice account we'll need your domain, key and secret.
 

data/lib/uvcli/version.rb

@@ -1,3 +1,3 @@
 module Uvcli
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/uvcli.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = "uvcli"
   spec.version       = Uvcli::VERSION
   spec.authors       = ["Boy van Amstel"]
-  spec.email         = ["boy@boyvanamstel.nl"]
+  spec.email         = ["boy@dangercove.com"]
   spec.summary       = "UserVoice Command Line Interface."
   spec.description   = "Manage your UserVoice account(s) from the command line."
-  spec.homepage      = "http://www.dangercove.com"
+  spec.homepage      = "https://www.github.com/dangercove/uvcli"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uvcli
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Boy van Amstel
@@ -54,7 +54,7 @@ dependencies:
         version: '0.19'
 description: Manage your UserVoice account(s) from the command line.
 email:
-- boy@boyvanamstel.nl
+- boy@dangercove.com
 executables:
 - uvcli
 extensions: []
@@ -70,8 +70,10 @@ files:
 - lib/uvcli/cli.rb
 - lib/uvcli/settings.rb
 - lib/uvcli/version.rb
+- screenshots/commands.jpg
+- screenshots/tickets.jpg
 - uvcli.gemspec
-homepage: http://www.dangercove.com
+homepage: https://www.github.com/dangercove/uvcli
 licenses:
 - MIT
 metadata: {}