Skip to content

Commit 0ce837f

Browse files
committed
Updated README
1 parent da4cb77 commit 0ce837f

File tree

1 file changed

+35
-14
lines changed

1 file changed

+35
-14
lines changed

README.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
### Usage
1212

13+
### main commands
14+
1315
Control your remote git hosting services from the `git` commandline. The usage is
1416
very simple. To clone a new project, out of github, just issue:
1517

@@ -48,6 +50,13 @@ and of course, you can delete it using:
4850

4951
% git bb delete guyzmo/git-repo
5052

53+
Also, you can open the repository's page, using the `open` command:
54+
55+
% git lab open guyzmo/git-repo
56+
Successfully fetched branch `2` of `guyzmo/git-repo` into `request-2`!
57+
58+
### Requests for merges *(aka Pull Requests aka Merge Requests)*
59+
5160
Once you're all set with your repository, you can check requests to merge
5261
(aka Pull Requests on github) using the `request` command:
5362

@@ -60,10 +69,11 @@ And fetch it locally to check and/or amend it before merging:
6069

6170
% git hub request guyzmo/git-repo fetch 2
6271

63-
Finally, you can open the repository's page, using the `open` command:
72+
Or you can create a pull-request by doing a:
6473

65-
% git lab open guyzmo/git-repo
66-
Successfully fetched branch `2` of `guyzmo/git-repo` into `request-2`!
74+
% git hub request create guyzmo/git-repo myfeature master 'My neat feature' -m 'So much to say about that feature…'
75+
76+
### Gists or snippets
6777

6878
Finally, another extra feature you can play with is the gist handling:
6979

@@ -119,8 +129,17 @@ or by getting the sources and running:
119129

120130
### Configuration
121131

122-
To configure `git-repo` you need to tweak your `~/.gitconfig`. For each service
123-
you've got an account on, you have to make a section in the gitconfig:
132+
To configure `git-repo` you simply have to call the following command:
133+
134+
% git repo config
135+
136+
and a wizard will run you through getting the authentication token for the
137+
service, add the command alias or the name of the remote. Though, configuring
138+
custom services is still not handled by the wizard…
139+
140+
But if you prefer manual configuration you'll have to tweak your
141+
`~/.gitconfig`. For each service you've got an account on, you have to make a
142+
section in the gitconfig:
124143

125144
[gitrepo "gitlab"]
126145
token = YourVerySecretKey
@@ -218,21 +237,23 @@ To use your own credentials, you can setup the following environment variables:
218237
* [x] refactor the code into multiple modules
219238
* [x] add regression tests (and actually find a smart way to implement them…)
220239
* [x] add travis build
240+
* [x] show a nice progress bar, while it's fetching (cf [#15](https://github.com/guyzmo/git-repo/issues/15))
221241
* [ ] add support for handling gists
222242
* [x] github support
223-
* [ ] gitlab support
224-
* [ ] bitbucket support
243+
* [ ] gitlab support (cf [#12](https://github.com/guyzmo/git-repo/issues/12))
244+
* [ ] bitbucket support (cf [#13](https://github.com/guyzmo/git-repo/issues/13))
225245
* [ ] add support for handling pull requests
226246
* [x] list them
227247
* [x] fetch them as local branches
228248
* [x] github support
229-
* [ ] gitlab support
230-
* [ ] bitbucket support
231-
* [ ] add OAuth support for bitbucket
232-
* [ ] show a nice progress bar, while it's fetching
233-
* partly implemented: the issue looks like that gitpython expects output from git
234-
on stderr, whereas it's outputing on stdout.
235-
* [ ] do what's needed to make a nice documentation (if possible in markdown !@#$)
249+
* [ ] gitlab support (cf [#10](https://github.com/guyzmo/git-repo/issues/10))
250+
* [ ] bitbucket support (cf [#11](https://github.com/guyzmo/git-repo/issues/11))
251+
* [ ] add OAuth support for bitbucket (cf [#14](https://github.com/guyzmo/git-repo/issues/14))
252+
* [ ] add support for managing SSH keys (cf [#22](https://github.com/guyzmo/git-repo/issues/15))
253+
* [ ] add support for issues?
254+
* [ ] add support for gogs (cf [#18](https://github.com/guyzmo/git-repo/issues/18))
255+
* [ ] add support for gerrit (cf [#19](https://github.com/guyzmo/git-repo/issues/19))
256+
* [ ] do what's needed to make a nice documentation — if possible in markdown !@#$
236257
* for more features, write an issue or, even better, a PR!
237258

238259
### License

0 commit comments

Comments
 (0)