Skip to content
This repository has been archived by the owner on Mar 30, 2020. It is now read-only.

Commit

Permalink
Added usage section
Browse files Browse the repository at this point in the history
  • Loading branch information
chalkpe committed May 1, 2017
1 parent 55ae1f3 commit 75ea2fc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ Welcome message for shells
$ npm install -g welcomes
```

## Usage
Add `welcomes --config config.json`
or `welcomes time hangang custom-a custom-b --configs`
to your [run commands](https://en.wikipedia.org/wiki/Run_commands) file (`.bashrc`, `.bash_profile` or `.zshrc` etc.)

* Pre-installed plugins: `time`, `hangang`, `dimibob`
* `custom-a` is short for `welcomes-plugin-custom-a` npm package

## Configuration

### Basic
Expand Down

0 comments on commit 75ea2fc

Please sign in to comment.