Merge pull request #2 from elnaz/peer-dep

fix(install): add hapi-auth-basic as a peer dependency
elnaz · Jul 26, 2016 · ab523cb · ab523cb
2 parents ae95e80 + 7137742
commit ab523cb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/elnaz/hapi-tiny-auth.svg)](https://travis-ci.org/elnaz/hapi-tiny-auth)
 
-Just enough authentication to make an API private. This [Hapi](http://hapijs.com/) plugin will allow only one set of configured credentials to access any of the API's endpoints.
+Just enough authentication to make an API private. This [Hapi](http://hapijs.com/) plugin will allow only one set of configured credentials to access any of the API's endpoints. Must be used with [hapi-auth-basic](https://github.com/hapijs/hapi-auth-basic).
 
 ## Install
 
@@ -18,6 +18,7 @@ const Hapi = require('hapi');
 const server = new Hapi.Server();
 
 server.register([
+  require('hapi-auth-basic'),
   {
     register: require('hapi-tiny-auth'),
     options: {

diff --git a/package.json b/package.json
@@ -33,6 +33,9 @@
     "url": "https://github.com/elnaz/hapi-tiny-auth/issues"
   },
   "homepage": "https://github.com/elnaz/hapi-tiny-auth#readme",
+  "peerDependencies": {
+    "hapi-auth-basic": ">=3.x"
+  },
   "devDependencies": {
     "chai": "^3.0.0",
     "eslint": "^1.9.0",