alfred_git 0.1.4 → 0.1.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -22
  3. data/lib/alfred_git/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d9c52f0460bf4fd9192f20a4d29235c8aadcfd2b
4
- data.tar.gz: a70405de545cf386eb36af215b8b2bf14b1300b7
3
+ metadata.gz: 6427181f7ce9b369109ef6f2592c8303ba088c1e
4
+ data.tar.gz: 0fc13ba5a52356ee97168cade1000d53afbc997e
5
5
  SHA512:
6
- metadata.gz: 271e8c2658d0abeb08b9155eec96c48de6d6277d8cd77341ed6f0305ecdcfb31db288ebe70c0836b2fed8e1b1692bd3ee2ed568d7e3ff9d48d13d22b48e6f5f6
7
- data.tar.gz: 4d38451b33c49c98d2b40ea241f6279769460893cffbfb41bba17a3819f1d9eced69cf40fc34c71034bb0c09cd43c0ca901b2a1df184170716d143ec1e121ace
6
+ metadata.gz: 74d1e8a90d4b88494e827f3faa3f769bb9f35c11d95d19748b40bc52d42ab465bbe1a1c478f4ed5bc946124841ae210f199c12fedf6af94d3a946628e07c2cca
7
+ data.tar.gz: 728cfaac0583875612ce5d3c9f77eb4609d7a79b9c4173897502afd8c3060bc57d47e5a0acab837561fb0e8a34dbf5bc1626e7e80fb721f400b67900cab1b331
data/README.md CHANGED
@@ -20,35 +20,36 @@ Enter AlfredGit, named after a certain famous billionaire's butler. AlfredGit do
20
20
  those stupid menial typing tasks for you. Why? Because you're freaking Batman
21
21
  and Batman doesn't have time to sit there cd-ing into 12 different repo
22
22
  directories and issuing a `git pull` in every single one of them. He's too
23
- busy out there punching...uh...bugs and...feature requests. In the face (this
23
+ busy out there punching...uh...bugs and...feature requests in the face (this
24
24
  analogy is quickly falling apart). So grab AlfredGit and say goodbye to
25
25
  spending 20% of your day typing git commands in 140 different repos like a
26
26
  pleb. This, guys. This is the future.
27
27
 
28
28
  # Installation
29
29
 
30
- I'd recommend holding off on this for right now, as I'm planning on gem-ifying
31
- this soon enough. Once that's done, an install will be as easy as typing `gem
32
- install alfred` or something similar. Pretty sure someone already took that
33
- gem name even though their app doesn't even compare and doesn't deserve the
34
- moniker.
30
+ An install is as easy as typing `gem install alfred_git` on your command line
31
+ (you need to have ruby installed). At that point, all you need to do to run
32
+ the app is type `alfred_git`.
35
33
 
36
34
  # Use
37
35
 
38
36
  I've tried to make the command syntax as intuitive as possible. Essentially,
39
37
  you'll send in a few parameters (the exact number of parameters required
40
38
  changes based on what git command you need to run - you can't run a `git
41
- checkout` without a branch name, for instance) separated by spaces; the repos
42
- you want to work with *always* come last and will also be separated by spaces.
43
- Want to do all of the repos, but don't want to type them all out? Of course
44
- you do! Why else would you be using this app? Just run AlfredGit with the word
45
- 'all' as your last parameter.
46
-
47
- AlfredGit comes packaged with the most common git commands built in, but also
48
- allows you to send custom commands! If your first parameter doesn't match
49
- any of the built-in commands, the first parameter itself will be the command
50
- that is run! Simple! Think another command warrants being on this list?
51
- Email me and I'll consider adding it!
39
+ checkout` without a branch name, for instance) separated by spaces; the
40
+ important thing to remember is that repos you want to work with *always* be
41
+ your last/last few parameters and will also be separated by spaces. Want to do
42
+ all of the repos, but don't want to type them all out? Of course you do! Why
43
+ else would you be using this app? Just run AlfredGit with the word 'all' as
44
+ your last parameter. How does AlfredGit know your repos? You set them up when
45
+ you first run the app! After installation, just run the app and it'll run you
46
+ through the set up and explain along the way!
47
+
48
+ AlfredGit comes packaged with the most common git commands built in. I'm working
49
+ on getting custom commands to work with it as well, so you can send whatever
50
+ command you'd like to however many branches you'd like in one fell swoop! Simple!
51
+ Think another command warrants being on this list? Email me and I'll consider
52
+ adding it!
52
53
 
53
54
  And with that, we come to the built-in commands. Here are the AlfredGit commands
54
55
  followed by a description of what they run. Most of these should be intuitive.
@@ -56,23 +57,28 @@ followed by a description of what they run. Most of these should be intuitive.
56
57
  * `pull` - Runs a `git pull`
57
58
  * `push` - Runs a `git push`
58
59
  * `checkout second_parameter` - runs a `git checkout second_parameter`
59
- * `commit second_parameter` - Runs a `git commit -m second_parameter`
60
+ * `commit 'second_parameter'` - Runs a `git commit -m second_parameter`
60
61
  * `status` - Runs a `git status`
61
- * `branch` or `branches` - Lists the branches your repos currently have
62
+ * `branch` or `branches` - Lists the branch(es) your repo(s) currently have
62
63
  checked out.
63
64
 
64
65
  # Quick Example
65
- Here's a quick example of how it works!
66
+ Here's a quick example of how it works! When you set AlfredGit up, you'll point
67
+ to the locations of all of your repos and give them 'friendly' names with which
68
+ you can quickly refer to them. For the sake of these examples, we'll assume
69
+ that you are completely unimaginative (and really good at remembering numbers)
70
+ and that you've set up 4 repos and named them 'repo_1', 'repo_2', 'repo_3',
71
+ and 'repo_4'.
66
72
 
67
73
  Want to pull repos 1, 2, and 3? Easy!
68
74
 
69
75
  `> alfred_git pull repo_1 repo_2 repo_3`
70
76
 
71
- What about pulling everything?
77
+ What about pulling every repo?
72
78
 
73
79
  `> alfred_git pull all`
74
80
 
75
- How about checking out a branch on multiple repos at once?
81
+ How about checking out a branch named 'branch_name' on multiple repos at once?
76
82
 
77
83
  `> alfred_git checkout branch_name repo_1 repo_2`
78
84
 
@@ -1,3 +1,3 @@
1
1
  module AlfredGit
2
- VERSION = "0.1.4"
2
+ VERSION = "0.1.6"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: alfred_git
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.4
4
+ version: 0.1.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Chris Sellek
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-05-17 00:00:00.000000000 Z
11
+ date: 2016-05-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rainbow