elwayman02/jordan-hawker-cli

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Jordan Hawker CLI

[![Build Status](https://travis-ci.org/elwayman02/jordan-hawker-cli.svg?branch=master)](https://travis-ci.org/elwayman02/jordan-hawker-cli)
[![npm version](https://badge.fury.io/js/jordan-hawker.svg)](http://badge.fury.io/js/jordan-hawker)
[![Dependency Status](https://www.versioneye.com/user/projects/55d81ce38d9c4b001b000001/badge.svg?style=flat)](https://www.versioneye.com/user/projects/55d81ce38d9c4b001b000001)
[![Code Climate](https://codeclimate.com/github/elwayman02/jordan-hawker-cli/badges/gpa.svg)](https://codeclimate.com/github/elwayman02/jordan-hawker-cli)
[![Codacy Badge](https://www.codacy.com/project/badge/a9ce5d63509844308ad226082801c1a0)](https://www.codacy.com/app/hawker-jordan/jordan-hawker-cli)

[![NPM](https://nodei.co/npm/jordan-hawker.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/jordan-hawker/)

## Installation

```shell
npm install -g jordan-hawker
```

## Usage

#### Help

```shell
jordan-hawker -h
```
*Alias: --help*

#### All

Runs all main commands (no sub-commands)

```shell
jordan-hawker -a
```
*Alias: --all*

#### Blog

Display a link to my blog

```shell
jordan-hawker -b
```
*Alias: --blog*

#### Contact

Display a link to my contact page

```shell
jordan-hawker -c
```
*Alias: --contact*

#### Email

Display my email address

```shell
jordan-hawker -e
```
*Alias: --email*

#### GitHub

Display a link to my GitHub page

```shell
jordan-hawker -g
```
*Alias: --github*

You can also access more GitHub information using the `github` command.

The following options are supported:

##### Repositories

```shell
jordan-hawker github -r
```
*Alias: --repos*

##### Followers

```shell
jordan-hawker github -f
```
*Alias: --followers*

#### Google+

Display my Google+ handle

```shell
jordan-hawker -+
```
*Alias: --googleplus*

#### LinkedIn

Display a link to my LinkedIn profile

```shell
jordan-hawker -l
```
*Alias: --linkedin*

#### StackOverflow

Display a link to my StackOverflow profile

```shell
jordan-hawker -s
```
*Alias: --stackoverflow*

#### Twitter

Display my Twitter handle

```shell
jordan-hawker -t
```
*Alias: --twitter*

#### Website

Display a link to my website

```shell
jordan-hawker -w
```
*Alias: --website*

## Contributing

Check out [CONTRIBUTING.md](https://github.com/elwayman02/jordan-hawker-cli/blob/master/CONTRIBUTING.md) 
for more information on contributing to this project.

## License

[MIT](http://opensource.org/licenses/MIT) ([LICENSE.md](https://github.com/elwayman02/jordan-hawker-cli/blob/master/LICENSE.md))