diff --git a/README.md b/README.md index 9db5cb54..f2fb2226 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # marked -> A full-featured markdown parser and compiler, written in JavaScript. Built -> for speed. +[![NPM version](https://badge.fury.io/js/marked.svg)][badge] [![NPM dependencies](https://david-dm.org/markedjs/marked.svg)][badge] -[![NPM version](https://badge.fury.io/js/marked.svg)][badge] +Marked is + +1. built for speed.* +2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.** +3. light-weight while implementing all markdown features from the supported flavors & specifications.*** +4. available as a command line interface and running in client- or server-side JavaScript projects. + +- * Still working on metrics for comparative analysis and definition. +- ** As few dependencies as possible. +- *** Strict compliance could result in slower processing when running comparative benchmarking. -

Philosophy behind marked

- -The point of marked was to create a markdown compiler where it was possible to -frequently parse huge chunks of markdown without having to worry about -caching the compiled output somehow...or blocking for an unnecessarily long time. - -marked is very concise and still implements all markdown features. It is also -now fully compatible with the client-side. - -marked more or less passes the official markdown test suite in its -entirety. This is important because a surprising number of markdown compilers -cannot pass more than a few tests. It was very difficult to get marked as -compliant as it is. It could have cut corners in several areas for the sake -of performance, but did not in order to be exactly what you expect in terms -of a markdown rendering. In fact, this is why marked could be considered at a -disadvantage in the benchmarks. - -Along with implementing every markdown feature, marked also implements [GFM -features][gfmf]. -

Install

``` bash