Skip to content

Commit

Permalink
docs(README): add badges and correct typos
Browse files Browse the repository at this point in the history
 * add travis build badge
 * add codeclimate badge
 * add coverage badge
 * add npm package badge
 * correct few typos
  • Loading branch information
alvaropinot committed Nov 4, 2016
1 parent 44a2629 commit 465b25b
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
@@ -1,11 +1,12 @@
![exprexo logo](https://cloud.githubusercontent.com/assets/6654199/19909620/caa6041a-a088-11e6-818e-f376f45ec138.png)


[![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

# exprexo - hacked javascript freshly served

> exprexo and javascript make the perfect blend
# exprexo [![Standard - JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![Build Status](https://travis-ci.org/exprexo/exprexo.svg?branch=master)](https://travis-ci.org/exprexo/exprexo) [![Code Climate](https://codeclimate.com/github/exprexo/exprexo/badges/gpa.svg)](https://codeclimate.com/github/exprexo/exprexo) [![Test Coverage](https://codeclimate.com/github/exprexo/exprexo/badges/coverage.svg)](https://codeclimate.com/github/exprexo/exprexo/coverage) [![npm version](https://badge.fury.io/js/exprexo.svg)](https://www.npmjs.com/package/exprexo)

hacked javascript freshly served


# What is exprexo

Expand All @@ -23,6 +24,8 @@ Installation via `npm`:

This will install **exprexo** globally so that it may be run from the command line.

> exprexo and javascript make the perfect blend
## Usage

exprexo [path] [options]
Expand Down Expand Up @@ -97,7 +100,7 @@ Create a file named `get.json` that may look as follows:
}
```

Now run the following and open `http://localhost:9000/cool/users`
Now run the following and browse `http://localhost:9000/cool/users`

```
$ exprexo
Expand Down Expand Up @@ -149,7 +152,7 @@ $ exprexo
```

**NOTE:** **exprexo** uses the same API as any **express** middleware.
Define `req` and `res` as your function arguments and you are done.
Define `req` and `res` as your function arguments and it's done.
If you prefer a classic `return` statement **exprexo** will send that for you.


Expand All @@ -162,7 +165,7 @@ same method name.
Want a new **POST** endpoint?
Create a `post.json` or `post.js`, it's that easy.

You cant create the following supported methods.
You can create the following supported methods:

| Method | exprexo file name |
| ------------- | ----------------------------- |
Expand Down

0 comments on commit 465b25b

Please sign in to comment.