gitter-markdown-processor/README.md

parses gitter chat messages, but in its own process

gitter-markdown-processor
=========================

Processes Gitter markdown messages and returns html with metadata.

```javascript
var processor = new Processor();

processor.process('Can someone look at #12?', function(err, result) {
  console.log(result);
  /*
   * {
   *   html: 'Can someone look at <span data-link-type="issue" data-issue="12" class="issue">#12</span>?',
   *   urls: [],
   *   mentions: [],
   *   issues: [ { number: '12' } ]
   * }
   */
});

processor.shutdown(function(err) {
  if(err) console.error('Uh oh, you should check for leftover processes', err);
});

```

Versioning
----------

In order to make versioning of messages easier, any change to the output of `processor.process()` is a breaking change. This means that under semver, we will release a new major version.

Its also why the first public release of this module is version `7.0.0`.