Skip to content

Commit

Permalink
cleaning up and clarifying language in output and in README for consi…
Browse files Browse the repository at this point in the history
…stency
  • Loading branch information
machellerogden committed Feb 10, 2017
1 parent 4d01924 commit 0f85c00
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 20 deletions.
43 changes: 26 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,53 @@
# ![bitcar](https://raw.githubusercontent.com/carsdotcom/bitcar/master/resources/bitcar.png)

> seemlessly jump between repos from the command line
> Seemlessly jump between repos from the command line.
# requirements
## Requirements

* node 6.x.x or newer
* bash 3 or newer

_zsh support coming soon..._

# installation and setup
## Installation & Setup

npm i -g bitcar
bitcar --setup
```
npm i -g bitcar
bitcar --setup
```

**IMPORTANT: Now, start a new terminal session.**

## Usage

# usage
### Initialize Cache

## initialize cache

bitcar --init
```
bitcar --init
```

This is done automatically the first time you try and use bitcar, but you can also invoke it manually with the above command.

## refresh cache
### Refresh Cache

bitcar --refresh
```
bitcar --refresh
```

## search / clone / cd to repo
### Search / Clone / Change Directory to Repo

bit {searchTerm}
```
bit {searchTerm}
```

## open repo in browser
### Open Repo in Browser

bit --open {searchTerm}
```
bit --open {searchTerm}
```

`searchTerm` is optional. If no `searchTerm` is given, then bitcar will attempt to open the current directory's repo in the browser.
The `searchTerm` argument is optional. If no `searchTerm` is given, then bitcar will attempt to open the current directory's repo in the browser.

# license
## license

Apache 2.0
2 changes: 1 addition & 1 deletion cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ function cli(options) {
} else if (results.length) {
resultPromise = lib.getSourceResult(results[0]);
} else {
throw new Error('No results');
throw new Error('No results.');
}
if (options.open) {
return resultPromise.then(lib.openInBrowser).then(lib.maybeClone);
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "bitcar",
"version": "1.0.7",
"description": "seemlessly jump between repos from the command line",
"description": "Seemlessly jump between repos from the command line.",
"repository": {
"type": "git",
"url": "https://github.com/carsdotcom/bitcar.git"
Expand Down
5 changes: 4 additions & 1 deletion setup.js
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,10 @@ source $HOME/.bitcar/completions.sh

return fs.commit(function (err) {
if (err) return reject(err)
console.log('bitcar setup was successful');
console.log('');
console.log('Bitcar setup was successful!');
console.log('Enter `. ~/.bash_profile` and hit enter, or start a new terminal for changes to take effect.');
console.log('Please note you MUST use the alias you chose during setup. Except for the `bitcar --setup` command you just ran, DO NOT use the `bitcar` command directly or the tool will not work.');
return resolve();
});
});
Expand Down

0 comments on commit 0f85c00

Please sign in to comment.