Skip to content

Commit

Permalink
Merge pull request #77 from bnb/bnb/update-readme-md-intro
Browse files Browse the repository at this point in the history
Update README.md intro to be more visually attractive
  • Loading branch information
bnb authored Dec 3, 2018
2 parents b632444 + 1f77d8e commit 3b43c85
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
# Good First Issue
<h3 align="center">Good First Issue</h1>

[![Greenkeeper badge](https://badges.greenkeeper.io/bnb/good-first-issue.svg)](https://greenkeeper.io/)

A CLI for finding issues labeled with "good-first-issue" to _hopefully_ lower the barrier to contributing to open source projects.
<p align="center">
A CLI for finding issues labeled with "Good First Issue" to help lower the barrier to contributing to open source projects.
<br>
<a href="#usage">Usage</a> •
<a href="#projects">Projects</a> •
<a href="#contributing">Contributing</a>
</p>

<p align="center">
<a href="https://greenkeeper.io/"><img src="https://badges.greenkeeper.io/bnb/good-first-issue.svg"></a>
<a href="https://travis-ci.org/bnb/good-first-issue/branches"><img src="https://img.shields.io/travis/bnb/good-first-issue.svg"></a>
</p>

</p>

## Usage

Expand Down Expand Up @@ -101,6 +113,6 @@ You can pull your queries directly from a standard GitHub search! If you want to

As a CLI, `good-first-issue` uses the Commander.js CLI framework. If you want to better understand how our CLI is built, commander.js is pretty [well documented](https://github.com/tj/commander.js/). Also used are Chalk for terminal coloring and [boxen](https://github.com/sindresorhus/boxen) to simplify the output container implementation.

### Contributing
## Contributing

If you are interested in fixing issues and contributing directly to the code base, please see the document [CONTRIBUTING.md](./CONTRIBUTING.md)

0 comments on commit 3b43c85

Please sign in to comment.