diff --git a/README.md b/README.md index 575cfc0..6fefb4e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -# Rapptor [![Build Status](https://travis-ci.org/firstandthird/rapptor.svg?branch=master)](https://travis-ci.org/firstandthird/rapptor) [![Greenkeeper badge](https://badges.greenkeeper.io/firstandthird/rapptor.svg)](https://greenkeeper.io/) +

Rapptor

+ +

+ + Test Status + + + Lint Status + + NPM +

Rapptor is a lightweight library that sits on top of [hapi](http://hapijs.com). @@ -9,9 +19,17 @@ Rapptor is a lightweight library that sits on top of [hapi](http://hapijs.com). * Automatically add any method in the `methods` directory with [hapi-method-loader](https://github.com/firstandthird/hapi-method-loader). * Logging with [hapi-logr](https://github.com/firstandthird/hapi-logr). -## Install +## Installation -`npm install --save rapptor` +```sh +npm install rapptor +``` + +_or_ + +```sh +yarn add rapptor +``` ## Usage: @@ -73,3 +91,10 @@ module.exports = { Now you can call `server.method.somemethod()` in your code. See more information on method loading in [hapi-method-loader](https://github.com/firstandthird/hapi-method-loader). + + +--- + + + +_A [First + Third](https://firstandthird.com) Project_