add usage

Author: Charlike Mike Reagent

index.js

@@ -7,15 +7,21 @@
 
 'use strict';
 
-module.exports =  function metntionsRegex(opts) {
-  opts = opts || {};
+/**
+ * The correct mention(s) regex. Regex done right!
+ *
+ * @param  {Object} `options`
+ * @return {RegExp}
+ */
+module.exports =  function metntionsRegex(options) {
+  options = options || {};
 
-  var startSpace = opts.startSpace === false ? '' : '(?:\\s+)';
-  var endSpace = opts.endSpace === false ? '' : '(?:\\s+)';
-  var length = '{1,' + (opts.length || 30) + '}';
-  var match = opts.match || '\\w' + length;
+  var startSpace = options.startSpace === false ? '' : '\\s+';
+  var endSpace = options.endSpace === false ? '' : '\\s+';
+  var length = '{1,' + (options.length || 30) + '}';
+  var match = options.match || '\\w' + length;
 
-  match = opts.dot && !opts.match ? '[A-Za-z0-9_.]' + length : match
+  match = options.dot && !options.match ? '[A-Za-z0-9_.]' + length : match
 
-  return new RegExp(startSpace + '@(' + match + ')' + endSpace, opts.flags);
+  return new RegExp(startSpace + '@(' + match + ')' + endSpace, options.flags);
 };

readme.md

@@ -10,9 +10,62 @@ $ npm install mentions-regex
 $ npm test
 ```
 
+
 ## Usage
 > For more use-cases see [tests](./test.js)
 
+```js
+var mentionsRegex = require('mentions-regex');
+
+mentionsRegex().test('github @tunnckoCore')
+//=> false
+
+mentionsRegex({flags: 'g'}).test('github @tunnckoCore')
+//=> false
+
+mentionsRegex({endSpace: false}).test('github @tunnckoCore')
+//=> true
+
+var str = '@first github @tunnckoCore and @face some @al.so [email protected] global @last'
+
+str.match(mentionsRegex())
+//=> [' @tunnckoCore ']
+
+str.match(mentionsRegex({flags: 'g'}))
+//=> [' @tunnckoCore ', ' @face ']
+
+str.match(mentionsRegex({flags: 'g', startSpace: false}))
+//=> [' @tunnckoCore ', ' @face ', '@face ']
+
+str.match(mentionsRegex({flags: 'g', endSpace: false}))
+//=> [' @tunnckoCore ', ' @face ', ' @al', ' @last']
+
+str.match(mentionsRegex({flags: 'g', startSpace: false, endSpace: false}))
+//=> ['@first', '@tunnckoCore', '@face', '@al', '@here', '@last']
+
+str.match(mentionsRegex({length: 5}))
+//=> [' @face ']
+
+str.match(mentionsRegex({flags: 'g', dot: true}))
+//=> [' @tunnckoCore ', ' @face ', ' @al.so ']
+
+str.match(mentionsRegex({flags: 'g', dot: true, length: 5}))
+//=> [' @face ', ' @al.so ']
+```
+
+
+## [.metntionsRegex](index.js#L16)
+> Default regex is `\s+@(\w{1,30}|[A-Za-z0-9_.]{1,30})\s+`
+
+* `[options]` **{Object}**
+  - `startSpace` **{Boolean}** if `false`, will remove starting `\s+` from regex
+  - `endSpace` **{Boolean}** if `false`, will remove ending `\s+` from regex
+  - `length` **{Number}** maximum length of mention, default `30`
+  - `match` **{String}** what to match, default is `\w{1,30}`
+  - `flags` **{String}** every valid RegExp flag, default `undefined`
+  - `dot` **{Boolean}** replace options.match which is `\w` with `[A-Za-z0-9_.]`
+* `return` **{RegExp}**
+
 
 ## Authors & Contributors
 **Charlike Mike Reagent** [![author tips][author-gittip-img]][author-gittip]

test.js

@@ -8,6 +8,6 @@
 'use strict';
 
 var mentionsRegex = require('./index');
-var str = 'some @mention as @he.re a@nd @second ols @He-wee more @men.tion'
-
-console.log(str.match(mentionsRegex({flags: 'g'})))
+var str = '@first github @tunnckoCore and @face some @al.so [email protected] global @last'
+var res = str.match(mentionsRegex({flags: 'g', dot: true}))
+console.log(res)