Skip to content

Commit 1acfcc4

Browse files
committed
README updated
1 parent bee1956 commit 1acfcc4

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

+38-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
1-
# coderockr-way-github-setup
2-
Basic setup to use the Coderockr Way methodology
1+
Coderockr Way Github Setup
2+
--------------------------
3+
Using this script the GitHub project will setup it to add the basic labels needed to control your issues according with the *Coderockr Way* methodology
4+
5+
You can take a look here: https://github.com/coderockr/coderockr-way-github-setup/labels
6+
7+
How to use
8+
----------
9+
This repository has a script named [`coderockr-way-github-setup.bash`](coderockr-way-github-setup.bash) there are two ways to use it.
10+
11+
You could just call it direct from GitHub using cURL, and it will ask you the info to updated your repository:
12+
13+
```bash
14+
$ bash -c "$(curl -sL https://raw.githubusercontent.com/coderockr/coderockr-way-github-setup/master/coderockr-way-github-setup.bash)"
15+
Type your Github repository name (owner/repo_name): lucassabreu/coderockr-way-github-setup
16+
Type your Github username: lucassabreu
17+
Type your Github password (won't be shown):
18+
```
19+
20+
Or you [install into your machine](#install) and run it directaly setting parameters (or not and it will be asked as shown before):
21+
22+
Usage: `coderockr-way-github-setup -u githubUser -p githubPassword owner/repo`
23+
24+
```
25+
--user, -u GitHub username
26+
--password, -p GitHub password
27+
--verbose, -v Details process
28+
```
29+
30+
Install
31+
-------
32+
33+
To install into your machine just run the commands bellow, and then use the command `coderockr-way-github-setup`.
34+
35+
```sh
36+
curl -sL "https://raw.githubusercontent.com/coderockr/coderockr-way-github-setup/master/coderockr-way-github-setup.bash" -o "/usr/local/bin/coderockr-way-github-setup"
37+
chmod a+x /usr/local/bin/coderockr-way-github-setup
38+
```

0 commit comments

Comments
 (0)