Updated readme, added an additional invalid test.

DavidTPate · Oct 17, 2014 · ec24e2b · ec24e2b
1 parent 0564d9d
commit ec24e2b
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-isuri
+isUri
 =====
 [![NPM version](https://badge.fury.io/js/isuri.svg)](http://badge.fury.io/js/isuri)
 [![Build Status](https://travis-ci.org/DavidTPate/isuri.svg?branch=master)](https://travis-ci.org/DavidTPate/isuri)
 [![Coverage Status](https://img.shields.io/coveralls/DavidTPate/isuri.svg?branch=master)](https://coveralls.io/r/DavidTPate/isuri)
 
-Pure Javascript implementation for truly checking if the provided input is an URI. Based on RFC 3986
+Pure Javascript implementation for truly checking if the provided input is an URI. Compliant with [RFC 3986](http://tools.ietf.org/html/rfc3986) and documented!
 
 ## Install
 
@@ -15,11 +15,10 @@ $ npm install isuri
 
 ## Node.js
 ```js
-var isuri = require('isuri');
-function isUri(str) {
-    return isuri(str);
-}
-});
+var isUri = require('isuri');
+
+isUri.test('http://example.com'); // returns true
+isUri.test('Bananas in pajamas are coming down the stairs'); // returns false
 ```
 
 ## License

diff --git a/test/test.js b/test/test.js
@@ -18,7 +18,8 @@
                 'http://[1080:0:0:0:8:800:200C:417A]'
             ],
             invalidUris = [
-                'file:/asda'
+                'file:/asda',
+                'qwerty'
             ];
         it('should be instantiated', function () {
             lib.should.be.ok;