uvcli 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -12
  3. data/lib/uvcli/cli.rb +1 -1
  4. data/lib/uvcli/version.rb +1 -1
  5. data/screenshots/commands.jpg +0 -0
  6. data/screenshots/tickets.jpg +0 -0
  7. data/uvcli.gemspec +2 -2
  8. metadata +5 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 353ed54e36ae32b3df177e0049506e04f60a3b6f
4
- data.tar.gz: fd389bd0d3978eae204ec043b0215782e915cf16
3
+ metadata.gz: 3f2123b65a58279da3fd7aa6e17c120bdd5c1805
4
+ data.tar.gz: e8a4251b81e32a5fc2a17db457572202e2a4336e
5
5
  SHA512:
6
- metadata.gz: 0ffb0c223bca5463222404511b44a3cb094920a8bc2fde0f93628bae608404ebb21991f906c8afd854468d20efeeb3f5c7610439d8e3305ee068e89f765a31c6
7
- data.tar.gz: 1943d4fc3ac787c293a2f276c4d62801783790b18e0de8f5f4593dd5f8bf2024fbc52bb277164da91735e070b486cb543f020407f98adb54f367b82bee9a549c
6
+ metadata.gz: ad68de32bfd3941b2e5441947dd4d6650a83d9f052ae0726c9d298e518b29b2f5d3ce5d497103c9ddf8c3f1286cc2d66f53892b2656230daecb7f07afe14afd9
7
+ data.tar.gz: 90813f54204d6e33fc6c5e6eb7f6303864b6a5426a0f7da2925a8a8b6ca2e3075372d63642a54e9d6677618ad459a0d2022a8dcead44064b15b68b421d534d4f
data/README.md CHANGED
@@ -1,30 +1,42 @@
1
1
  # Uvcli
2
2
 
3
- Uvcli is a command line interface for the UserVoice support and feedback platform.
3
+ Uvcli is a command line interface for the [UserVoice](https://www.uservoice.com) support and feedback platform.
4
4
 
5
5
  ## Installation
6
6
 
7
- Add this line to your application's Gemfile:
7
+ Open a terminal window and install uvcli.
8
8
 
9
- ```ruby
10
- gem 'uvcli'
11
- ```
9
+ $ gem install uvcli
12
10
 
13
- And then execute:
11
+ ## Usage
14
12
 
15
- $ bundle
13
+ Uvcli takes two commands `login` and `check`.
16
14
 
17
- Or install it yourself as:
15
+ ![Uvcli commands](https://github.com/dangercove/uvcli/raw/master/screenshots/commands.jpg)
18
16
 
19
- $ gem install uvcli
17
+ ### Login
20
18
 
21
- ## Usage
19
+ Add new UserVoice sites to your configuration by running:
20
+
21
+ $ uvcli login
22
+
23
+ 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__.
24
+
25
+ ### Check
26
+
27
+ 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.
28
+
29
+ $ uvcli check
30
+
31
+ ![Uvcli tickets](https://github.com/dangercove/uvcli/raw/master/screenshots/tickets.jpg)
32
+
33
+ ### Removing sites
22
34
 
23
- TODO: Write usage instructions here
35
+ You can manually remove sites from the configuration file, located in `~/.uvcli/uvcli.yml`.
24
36
 
25
37
  ## Contributing
26
38
 
27
- 1. Fork it ( https://github.com/[my-github-username]/uvcli/fork )
39
+ 1. Fork it ( https://github.com/dangercove/uvcli/fork )
28
40
  2. Create your feature branch (`git checkout -b my-new-feature`)
29
41
  3. Commit your changes (`git commit -am 'Add some feature'`)
30
42
  4. Push to the branch (`git push origin my-new-feature`)
data/lib/uvcli/cli.rb CHANGED
@@ -8,7 +8,7 @@ module Uvcli
8
8
 
9
9
  @@settings = Uvcli::Settings.new
10
10
 
11
- desc "login", "Login to an existing UserVoice account."
11
+ desc "login", "Login to an existing UserVoice account"
12
12
  def login
13
13
  puts %{\nTo login to your UserVoice account we'll need your domain, key and secret.
14
14
 
data/lib/uvcli/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Uvcli
2
- VERSION = "0.0.3"
2
+ VERSION = "0.0.4"
3
3
  end
data/screenshots/commands.jpg ADDED
Binary file
data/screenshots/tickets.jpg ADDED
Binary file
data/uvcli.gemspec CHANGED
@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
7
7
  spec.name = "uvcli"
8
8
  spec.version = Uvcli::VERSION
9
9
  spec.authors = ["Boy van Amstel"]
10
- spec.email = ["boy@boyvanamstel.nl"]
10
+ spec.email = ["boy@dangercove.com"]
11
11
  spec.summary = "UserVoice Command Line Interface."
12
12
  spec.description = "Manage your UserVoice account(s) from the command line."
13
- spec.homepage = "http://www.dangercove.com"
13
+ spec.homepage = "https://www.github.com/dangercove/uvcli"
14
14
  spec.license = "MIT"
15
15
 
16
16
  spec.files = `git ls-files -z`.split("\x0")
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: uvcli
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
4
+ version: 0.0.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Boy van Amstel
@@ -54,7 +54,7 @@ dependencies:
54
54
  version: '0.19'
55
55
  description: Manage your UserVoice account(s) from the command line.
56
56
  email:
57
- - boy@boyvanamstel.nl
57
+ - boy@dangercove.com
58
58
  executables:
59
59
  - uvcli
60
60
  extensions: []
@@ -70,8 +70,10 @@ files:
70
70
  - lib/uvcli/cli.rb
71
71
  - lib/uvcli/settings.rb
72
72
  - lib/uvcli/version.rb
73
+ - screenshots/commands.jpg
74
+ - screenshots/tickets.jpg
73
75
  - uvcli.gemspec
74
- homepage: http://www.dangercove.com
76
+ homepage: https://www.github.com/dangercove/uvcli
75
77
  licenses:
76
78
  - MIT
77
79
  metadata: {}