Skip to content
This repository was archived by the owner on Nov 15, 2022. It is now read-only.

Script Setup labels for GitHub repository #1

Merged
merged 2 commits into from
Jan 5, 2017
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
README updated
  • Loading branch information
lucassabreu committed Jan 5, 2017
commit 76bce7da73f5d49dcb5872fa48e9b1debedc5df0
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
# coderockr-way-github-setup
Basic setup to use the Coderockr Way methodology
Coderockr Way Github Setup
--------------------------
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

You can take a look here: https://github.com/coderockr/coderockr-way-github-setup/labels

How to use
----------
This repository has a script named [`coderockr-way-github-setup.bash`](coderockr-way-github-setup.bash) there are two ways to use it.

You could just call it direct from GitHub using cURL, and it will ask you the info to updated your repository:

```bash
$ bash -c "$(curl -sL https://raw.githubusercontent.com/coderockr/coderockr-way-github-setup/master/coderockr-way-github-setup.bash)"
Type your Github repository name (owner/repo_name): lucassabreu/coderockr-way-github-setup
Type your Github username: lucassabreu
Type your Github password (won't be shown):
```

Or you [install into your machine](#install) and run it directaly setting parameters (or not and it will be asked as shown before):

Usage: `coderockr-way-github-setup -u githubUser -p githubPassword owner/repo`

```
--user, -u GitHub username
--password, -p GitHub password
--verbose, -v Details process
```

Install
-------

To install into your machine just run the commands bellow, and then use the command `coderockr-way-github-setup`.

```sh
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"
chmod a+x /usr/local/bin/coderockr-way-github-setup
```