Added first version and readme file

Author: jehna

README.md

@@ -1,4 +1,71 @@
-VerbalExpressions
-=================
+VerbalExpressions v0.1
+=====================
 
-JavaScript Regular expressions made easy
+## JavaScript Regular expressions made easy
+VerbalExpressions is a JavaScript librarty that helps to construct hard regular expressions.
+
+## How to get started
+
+Include the library and you're good to go!
+```HTML
+<scrit type="text/javascript" src="VerbalExpressions.js"></script>
+```
+
+## Examples
+
+Here's a couple of simple examples to give an idea of how VerbalExpressions work:
+
+### Testing if we have valid URL
+```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";
+
+// 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
+
+```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"
+```
+
+### Shorthand for string replace:
+```javascript
+var result = VerEx().find( "red" ).replace( "We have a red house", "blue" );
+alert( result2 ); // Outputs "We have a blue house"
+```
+
+## 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]:blog/2292-Extending-JavaScript-Arrays-While-Keeping-Native-Bracket-Notation-Functionality.htm

VerbalExpressions.js

@@ -0,0 +1,130 @@
+/*!
+ * VerbalExpressions JavaScript Library v0.1
+ * https://github.com/jehna/VerbalExpressions
+ *
+ *
+ * Released under the MIT license
+ * http://jquery.org/license
+ *
+ * Date: 2013-07-19
+ * 
+ */
+
+// Define the collection class.
+window.VerbalExpression = (function(){
+
+    // I am the constructor function.
+    function VerbalExpression(){
+        var verbalExpression = Object.create( RegExp.prototype );
+        
+        // Initialize 
+        verbalExpression = (RegExp.apply( verbalExpression, arguments ) || verbalExpression);
+     
+        // Add all the class methods
+        VerbalExpression.injectClassMethods( verbalExpression );
+
+        // Return the new object.
+        return( verbalExpression );
+    }
+ 
+ 
+    // Define the static methods.
+    VerbalExpression.injectClassMethods = function( verbalExpression ){
+ 
+        // Loop over all the prototype methods
+        for (var method in VerbalExpression.prototype){
+ 
+            // Make sure this is a local method.
+            if (VerbalExpression.prototype.hasOwnProperty( method )){
+ 
+                // Add the method
+                verbalExpression[ method ] = VerbalExpression.prototype[ method ];
+ 
+            }
+ 
+        }
+        
+        return( verbalExpression );
+ 
+    };
+ 
+ 
+    // Define the class methods.
+    VerbalExpression.prototype = {
+        
+        _source : "",
+        
+        lol: function( value ){
+            console.log( "loL" );
+            this.compile( value );
+            return( this );
+        },
+        
+        sanitize : function( value ) {
+            return value.replace(/[^\w]/g, function(character) { return "\\" + character; });
+        },
+        
+        startOfLine: function() {
+            if(this.source.indexOf( "^" ) !== 0) this._source = "^" + this._source;
+            this.add( "" );
+            return( this );
+        },
+        
+        add: function( value ) {
+            this._source += value || "";
+            this.compile(this._source);
+            return( this );
+        },
+        
+        then : function( value ) {
+            value = this.sanitize(value);
+            this.add( "(" + value + ")" );
+            return( this );
+        },
+        
+        find : function( value ) {
+            return( this.then( value ) );
+        },
+        
+        maybe : function( value ) {
+            value = this.sanitize(value);
+            this.add( "(" + value + ")?" );
+            return( this );
+        },
+        
+        anything : function() {
+            this.add( "(.*)" );
+            return( this );
+        },
+        
+        endOfLine : function() {
+            this.add( "$" );
+            return( this );
+        },
+        
+        anythingBut : function( value ) {
+            value = this.sanitize(value);
+            this.add( "([^" + value + "]*)" );
+            return( this );
+        },
+        
+        replace : function( source, value ) {
+            source = source.toString();
+            return source.replace( this, value );
+        }
+ 
+    };
+ 
+ 
+    // Return the constructor.
+    return( VerbalExpression );
+ 
+ 
+}).call( {} );
+
+// Create shorthand
+(function(w) { 
+    w.VerEx = function() {
+        return new VerbalExpression();
+    };
+})(window);