hiraishin 0.0.1 → 0.0.3

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 (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +63 -0
  3. data/hiraishin.gemspec +1 -1
  4. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d6fd25acc2fa0c00472acbac67d3c7b9d849cf4762642b9b7fbda48b516a311d
4
- data.tar.gz: b4efcf6fc11951fbaf3a6d2fa1acc38bff8108df2bdc4107654e1de4f53c8a5b
3
+ metadata.gz: d8886d7a6ccacd1f15f8324990b5b137e77e0ba1a2b27593ee81c8f0cc018acd
4
+ data.tar.gz: cd115c2addecd3ab6817a89ea22a23565884af8cc75c614285fd073b395eab4d
5
5
  SHA512:
6
- metadata.gz: 227ee32dfb1513ba7fb4976a84f9f3934a4b549a0908b5cd59ba1b2a8bc5ae82379c7da4499085b61f12a7b70562f832ae73de431716fe54aa3077d9b30a39ed
7
- data.tar.gz: 93fcb419ae27d18d81b091c80d8088abd4d2a7e9075fbc00e44d70a1a0d3c333332f83980172012d817268ba1cd11eb6997d9a0d372a15d1cee116f11948555e
6
+ metadata.gz: c70deb9606c6ec8a1ad2c62ad081c78dcf509eb023bd4b73a187dd6d55bae298d21990a8abec556971060ddd7f2a039bb93419f34dce0b4245de64a484f38978
7
+ data.tar.gz: 566e9b000d85ca542d8a9fac132c68b931a7433eed521910764ca2ef63d61a19dc3a3f6af49436085fb3679d302d0c690d1fbd0ab1520d2cefb0a37a4dd92bb3
@@ -0,0 +1,63 @@
1
+ ![Travis (.org) branch](https://img.shields.io/travis/LuanGB/hiraishin/master.svg) ![Gem](https://img.shields.io/gem/v/hiraishin.svg) [![Gem](https://img.shields.io/gem/dt/hiraishin.svg)](https://rubygems.org/gems/hiraishin) ![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)
2
+
3
+
4
+ # Hiraishin
5
+
6
+
7
+ A simple gem that adds executable and library for adding shortcuts to programs.
8
+ Check the rubygems link [here](http://rubygems.org/gems/hiraishin)
9
+
10
+
11
+ ## Name
12
+
13
+
14
+ This gem was named after Yondaime Hokage's main technique [Flying Raijin Jutsu](http://naruto.wikia.com/wiki/Flying_Thunder_God_Technique) (or *Hiraishin no Jutsu*, in Rōmaji), witch allows the user to instantaneously teleport themselves to a previously marked location.
15
+ Similarly, this gem allow its user to create shortcuts and bind them to commands, allowing instant access.
16
+
17
+
18
+ ### Installing
19
+
20
+
21
+ Using rubygems:
22
+ ```bash
23
+ gem install hiraishin
24
+ ```
25
+
26
+
27
+ ### Usage
28
+
29
+
30
+ Command line utility usage example:
31
+ ```bash
32
+ hiraishin -n browser -c /usr/bin/google-chrome -k Ctrl,Alt,Shift,c
33
+ ```
34
+
35
+
36
+ Command line utility help:
37
+ ```
38
+ Usage: hiraishin -n NAME -c path/to/command -k keys,to,be,pressed
39
+ -n, --name=NAME Name of the shortcut
40
+ -c, --command=COMMAND Command to be executed
41
+ -k, --keys=KEYS Keys to bind shortcut to
42
+ -h, --help Prints this help
43
+ ```
44
+
45
+
46
+ Using on a ruby program:
47
+ ```ruby
48
+ require 'hiraishin'
49
+
50
+
51
+ Hiraishin.add_shortcut_to_cinnamon 'browser', '/usr/bin/google-chrome', :Ctrl, :Alt, :Shift, :c
52
+ ```
53
+ ### To do
54
+
55
+
56
+ - add support to other GUIs (like MATE, GNOME etc)
57
+ - add some tests
58
+
59
+
60
+ ### Contributing
61
+
62
+
63
+ Please feel free to open issues and suggest improvements or functionality to this gem.
@@ -1,6 +1,6 @@
1
1
  Gem::Specification.new do |spec|
2
2
  spec.name = 'hiraishin'
3
- spec.version = '0.0.1'
3
+ spec.version = '0.0.3'
4
4
  spec.authors = ['Luan Gonçalves Barbosa']
5
5
  spec.email = ['luan.goncbs@gmail.com']
6
6
  spec.summary = 'A simple gem that adds executable and library for adding shortcuts to programs'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: hiraishin
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Luan Gonçalves Barbosa
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-08-14 00:00:00.000000000 Z
11
+ date: 2018-08-15 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description:
14
14
  email:
@@ -18,6 +18,7 @@ executables:
18
18
  extensions: []
19
19
  extra_rdoc_files: []
20
20
  files:
21
+ - README.md
21
22
  - bin/hiraishin
22
23
  - hiraishin.gemspec
23
24
  - lib/hiraishin.rb