Revert "update readme"

This reverts commit 9bbcdca.

Author: mihai-vlc

README.md

@@ -1,35 +1,77 @@
-##PHPVerbalExpressions 
-- ported from [VerbalExpressions](https://github.com/jehna/VerbalExpressions)
+VerbalExpressions v0.1
+=====================
 
-VerbalExpressions is a PHP library that helps to construct hard regular expressions.  
+## JavaScript Regular Expressions made easy
+VerbalExpressions is a JavaScript library that helps to construct difficult regular expressions.
 
+## How to get started
 
-```php
+Include the library and you're good to go!
+```HTML
+<script src="VerbalExpressions.js"></script>
+```
+
+## Examples
 
-// some tests
+Here's a couple of simple examples to give an idea of how VerbalExpressions works:
 
-$regex = new VerEx;
+### Testing if we have a valid URL
 
-$regex 	->startOfLine()
-		->then( "http" )
-		->maybe( "s" )
-		->then( "://" )
-		->maybe( "www." )
-		->anythingBut( " " )
-		->endOfLine();
+```javascript
+// Create an example of how to test for correctly formed URLs
+var tester = VerEx()
+            .startOfLine()
+            .then( "http" )
+            .maybe( "s" )
+            .then( "://" )
+            .maybe( "www." )
+            .anythingBut( " " )
+            .endOfLine();
 
+// Create an example URL
+var testMe = "https://www.google.com";
 
-if($regex->test("http://github.com"))
-	echo "valid url";
-else
-	echo "invalid url";
+// Use RegExp object's native test() function
+if( tester.test( testMe ) ) alert( "We have a correct URL "); // This output will fire
+else alert( "The URL is incorrect" );
+
+console.log( tester ); // Ouputs the actual expression used: /^(http)(s)?(\:\/\/)(www\.)?([^\ ]*)$/ 
+```
 
+### Replacing strings
 
-echo "<pre>". $regex->getRegex() ."</pre>";
+```javascript
+// Create a test string
+var replaceMe = "Replace bird with a duck";
 
+// Create an expression that seeks for word "bird"
+var expression = VerEx().find( "bird" );
+
+// Execute the expression like a normal RegExp object
+var result = replaceMe.replace( expression, "duck" );
+
+alert( result ); // Outputs "Replace duck with a duck"
+```
 
-echo $regex ->clean(array("modifiers"=> "m","replaceLimit"=>4))
-			->find(' ')
-			->replace("This is a small test http://somesite.com and some more text.", "-");
+### Shorthand for string replace:
 
+```javascript
+var result = VerEx().find( "red" ).replace( "We have a red house", "blue" );
+alert( result ); // Outputs "We have a blue house"
 ```
+
+## API documentation
+
+You can find the API documentation at the [wiki pages](https://github.com/jehna/VerbalExpressions/wiki).
+
+## A little word for a big help
+I'd like to promote a special thank-you to [Ben Nadel][ben-nadel] for his [great article about extending native JS objects][extending]
+
+## Contributions
+Clone the repo and fork:
+`git clone https://github.com/jehna/VerbalExpressions.git`.
+
+Pull requests are warmly welcome!
+
+[ben-nadel]:http://www.bennadel.com/
+[extending]:http://www.bennadel.com/blog/2292-Extending-JavaScript-Arrays-While-Keeping-Native-Bracket-Notation-Functionality.htm