Permalink
Browse files

Update README, preparing for 1.0.

  • Loading branch information...
1 parent 397e85b commit 8312cc54e4dbbda5efbc716b35844ed645878c1c @ariya committed Oct 5, 2012
Showing with 55 additions and 66 deletions.
  1. +28 −28 README.md
  2. +27 −38 index.html
View
@@ -1,40 +1,38 @@
-Esprima ([esprima.org](http://esprima.org)) is an educational
-[ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm)
-(also popularly known as [JavaScript](http://en.wikipedia.org/wiki/JavaScript>JavaScript))
-parsing infrastructure for multipurpose analysis. It is also written in ECMAScript.
+**Esprima** ([esprima.org](http://esprima.org)) is a high performance,
+standard-compliant [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm)
+parser written in ECMAScript (also popularly known as
+[JavaScript](http://en.wikipedia.org/wiki/JavaScript>JavaScript)).
+Esprima is created and maintained by [Ariya Hidayat](http://twitter.com/ariyahidayat),
+with the help of [many contributors](https://github.com/ariya/esprima/contributors).
-Esprima is created and maintained by [Ariya Hidayat](http://ariya.ofilabs.com/about)
-(Twitter: [@ariyahidayat](http://twitter.com/ariyahidayat)), with the help of
-[many contributors](https://github.com/ariya/esprima/contributors).
+Esprima runs on web browsers (IE 6+, Firefox 1+, Safari 3+, Chrome 1+, Konqueror 4.6+, Opera 8+) as well as
+[Node.js](http://nodejs.org).
### Features
-- Supports [ECMAScript 5.1](http://www.ecma-international.org/publications/standards/Ecma-262.htm)
-with an experimental branch for ES.Next/Harmony
-- Sensible format for the abstract syntax tree (AST), compatible with Mozilla
-[Parser API](https://developer.mozilla.org/en/SpiderMonkey/Parser_API)
-- Heavily tested (> 500 [unit tests](http://esprima.org/test/) with solid 100% code coverage)
+- Full support for [ECMAScript 5.1](http://www.ecma-international.org/publications/standards/Ecma-262.htm)(ECMA-262)
+- Sensible [syntax tree format](http://esprima.org/doc/index.html#ast) compatible with Mozilla
+[Parser AST](https://developer.mozilla.org/en/SpiderMonkey/Parser_API)
+- Heavily tested (> 550 [unit tests](http://esprima.org/test/) with solid 100% statement coverage)
- Optional tracking of syntax node location (index-based and line-column)
-- [Blazing fast](http://esprima.org/test/benchmarks.html) (3x faster than
-UglifyJS on the [speed comparison test](http://esprima.org/test/compare.html) using Chrome)
+- Experimental support for ES6/Harmony (module, class, destructuring, ...)
-Esprima runs on web browsers (IE 6+, Firefox 1+, Safari 3+, Chrome 1+, Konqueror 4.6+, Opera 8+) as well as
-[Node.js](http://nodejs.org).
+Esprima is blazing fast (see the [benchmark suite](http://esprima.org/test/benchmarks.html)).
+It is up to 3x faster than UglifyJS v1 and it is still [competitive](http://esprima.org/test/compare.html)
+with the new generation of fast parsers.
-### Use-cases
+### Applications
-- Smart editing: [outline view](https://github.com/aclement/esprima-outline), [content assist](http://contraptionsforprogramming.blogspot.com/2012/02/better-javascript-content-assist-in.html)
-- Source code modification: [Esmorph](https://github.com/ariya/esmorph), [Code Painter](https://github.com/fawek/codepainter),
- [node-falafel](https://github.com/substack/node-falafel), [Esmangle](https://github.com/Constellation/esmangle)
-- Code coverage analysis: [node-cover](https://github.com/itay/node-cover),
-[coveraje](https://github.com/coveraje/coveraje),
-[CoverJS](https://github.com/arian/CoverJS),
-[Istanbul](https://github.com/yahoo/Istanbul)
-- Code generation: [escodegen](https://github.com/Constellation/escodegen)
-- Documentation tool: [JFDoc](https://github.com/thejohnfreeman/jfdoc), [JSDuck](https://github.com/senchalabs/jsduck)
-- Source-to-source compilation: [Marv](https://github.com/Yoric/Marv-the-Tinker),
-[LLJS](http://mbebenita.github.com/LLJS/), [Six](https://github.com/matthewrobb/six), [Sweet.js](http://sweetjs.org/), [Harmonizr](https://github.com/jdiamond/harmonizr)
+Esprima serves as the basis for many popular JavaScript development tools:
+- Code coverage analysis: [node-cover](https://github.com/itay/node-cover), [Istanbul](https://github.com/yahoo/Istanbul)
+- Documentation tool: [JFDoc](https://github.com/thejohnfreeman/jfdoc), [JSDuck](https://github.com/senchalabs/jsduck)
+- Language extension: [LLJS](http://mbebenita.github.com/LLJS/) (low-level JS),
+[Sweet.js](http://sweetjs.org/) (macro)
+- ES6/Harmony transpiler: [Six](https://github.com/matthewrobb/six), [Harmonizr](https://github.com/jdiamond/harmonizr)
+- Eclipse Orion smart editing ([outline view](https://github.com/aclement/esprima-outline), [content assist](http://contraptionsforprogramming.blogspot.com/2012/02/better-javascript-content-assist-in.html))
+- Source code modification: [Esmorph](https://github.com/ariya/esmorph), [Code Painter](https://github.com/fawek/codepainter),
+- Source transformation: [node-falafel](https://github.com/substack/node-falafel), [Esmangle](https://github.com/Constellation/esmangle), [escodegen](https://github.com/Constellation/escodegen)
### Questions?
- [Documentation](http://esprima.org/doc)
@@ -43,6 +41,8 @@ and [future plans](http://code.google.com/p/esprima/issues/list?q=Enhancement)
- [Mailing list](http://groups.google.com/group/esprima)
- [Contribution guide](http://esprima.org/doc/index.html#contribution)
+Follow [@Esprima](http://twitter.com/Esprima) on Twitter to get the
+development updates.
Feedback and contribution are welcomed!
### License
View
@@ -20,56 +20,43 @@
<h1>Esprima <small>ECMAScript parsing infrastructure for multipurpose analysis</small></h1>
<div class="main">
-<p>Esprima (<a href="http://esprima.org">esprima.org</a>) is an educational
-<a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript</a>
-(also popularly known as <a href="http://en.wikipedia.org/wiki/JavaScript">JavaScript</a>)
-parsing infrastructure for multipurpose analysis. It is also written in ECMAScript.</p>
+<p><strong>Esprima</strong> is a high performance, standard-compliant
+<a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript</a> parser
+written in ECMAScript (also popularly known as
+<a href="http://en.wikipedia.org/wiki/JavaScript">JavaScript</a>).</p>
-<p>Esprima is created and maintained by <a href="http://ariya.ofilabs.com/about">Ariya Hidayat</a>
-(Twitter: <a href="http://twitter.com/ariyahidayat">@ariyahidayat</a>), with the help of
-<a href="https://github.com/ariya/esprima/contributors">many contributors</a>.</p>
+<p>Esprima runs on web browsers (IE 6+, Firefox 1+, Safari 3+, Chrome 1+, Konqueror 4.6+, Opera 8+) as well as
+<a href="http://nodejs.org">Node.js</a>.</p>
<h3>Features</h3>
<ul>
-<li>Supports <a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript 5.1</a>
-with an experimental branch for ES.Next/Harmony</li>
-<li>Sensible format for the abstract syntax tree (AST), compatible with Mozilla
-<a href="https://developer.mozilla.org/en/SpiderMonkey/Parser_API">Parser API</a></li>
-<li>Heavily tested (&gt; 500 <a href="http://esprima.org/test/">unit tests</a> with solid 100% code coverage)</li>
+<li>Full support for <a href="http://www.ecma-international.org/publications/standards/Ecma-262.htm">ECMAScript 5.1</a> (ECMA-262)</li>
+<li>Sensible <a href="doc/index.html#ast">syntax tree format</a>, compatible with Mozilla
+<a href="https://developer.mozilla.org/en/SpiderMonkey/Parser_API">Parser AST</a></li>
+<li>Heavily tested (&gt; 550 <a href="http://esprima.org/test/">unit tests</a> with solid 100% statement coverage)</li>
<li>Optional tracking of syntax node location (index-based and line-column)</li>
-<li>
-<a href="http://esprima.org/test/benchmarks.html">Blazing fast</a> (3x faster than
-UglifyJS on the <a href="http://esprima.org/test/compare.html">speed comparison test</a> using Chrome)</li>
+<li>Experimental support for ES6/Harmony (module, class, destructuring, ...)</li>
</ul>
-<p>Esprima runs on web browsers (IE 6+, Firefox 1+, Safari 3+, Chrome 1+, Konqueror 4.6+, Opera 8+) as well as
-<a href="http://nodejs.org">Node.js</a>.</p>
+<p>Esprima is blazing fast (see the <a href="http://esprima.org/test/benchmarks.html">benchmark suite</a>).
+It is up to 3x faster than UglifyJS v1 and it is still
+<a href="http://esprima.org/test/compare.html">competitive</a> with the new generation of fast parsers.</p>
-<h3>Use-cases</h3>
+<h3>Applications</h3>
-<ul>
-<li>Smart editing: <a href="https://github.com/aclement/esprima-outline">outline view</a>, <a href="http://contraptionsforprogramming.blogspot.com/2012/02/better-javascript-content-assist-in.html">content assist</a></li>
-<li>Source code modification: <a href="https://github.com/ariya/esmorph">Esmorph</a>, <a href="https://github.com/fawek/codepainter">Code Painter</a>,
-<a href="https://github.com/substack/node-falafel">node-falafel</a>, <a href="https://github.com/Constellation/esmangle">Esmangle</a></li>
-<li>Code coverage analysis: <a href="https://github.com/itay/node-cover">node-cover</a>,
-<a href="https://github.com/coveraje/coveraje">coveraje</a>,
-<a href="https://github.com/arian/CoverJS">CoverJS</a>,
-<a href="https://github.com/yahoo/Istanbul">Istanbul</a></li>
+Esprima serves as the basis for many popular JavaScript development tools:
-<li>Code generation: <a href="https://github.com/Constellation/escodegen">escodegen</a></li>
+<ul>
+<li>Code coverage analysis: <a href="https://github.com/itay/node-cover">node-cover</a>, <a href="https://github.com/yahoo/Istanbul">Istanbul</a></li>
<li>Documentation tool: <a href="https://github.com/thejohnfreeman/jfdoc">JFDoc</a>, <a href="https://github.com/senchalabs/jsduck">JSDuck</a></li>
-<li>Source-to-source compilation: <a href="https://github.com/Yoric/Marv-the-Tinker">Marv</a>,
-<a href="http://mbebenita.github.com/LLJS/">LLJS</a>,
-<a href="https://github.com/matthewrobb/six">Six</a>,
-<a href="http://sweetjs.org/">Sweet.js</a>,
-<a href="https://github.com/jdiamond/harmonizr">Harmonizr</a></li>
+<li>Language extension: <a href="http://mbebenita.github.com/LLJS/">LLJS</a> (low-level JS), <a href="http://sweetjs.org/">Sweet.js</a> (macro)</li>
+<li>ES6/Harmony transpiler: <a href="https://github.com/matthewrobb/six">Six</a>, <a href="https://github.com/jdiamond/harmonizr">Harmonizr</a></li>
+<li>Eclipse Orion smart editing (<a href="https://github.com/aclement/esprima-outline">outline view</a>, <a href="http://contraptionsforprogramming.blogspot.com/2012/02/better-javascript-content-assist-in.html">content assist</a>)</li>
+<li>Source transformation: <a href="https://github.com/substack/node-falafel">node-falafel</a>, <a href="https://github.com/Constellation/esmangle">Esmangle</a>, <a href="https://github.com/Constellation/escodegen">escodegen</a></li>
</ul>
-<p>Feedback and contribution are welcomed! Please join the
-<a href="http://groups.google.com/group/esprima">mailing list</a> and read the
-<a href="doc/index.html#contribution">contribution guide</a>
-for further info.</p>
+<p>Feedback is welcomed! Please join the discussion in the <a href="http://groups.google.com/group/esprima">mailing list</a>.</p>
</div>
@@ -104,8 +91,10 @@
<br clear="all"/>
-<div class="footer"><strong>Esprima</strong> is created by
-<a href="http://ariya.ofilabs.com/about" target="_blank">Ariya Hidayat</a>. Follow <a href="http://twitter.com/ariyahidayat">@ariyahidayat</a> on Twitter.
+<div class="footer">
+<strong>Esprima</strong> is created and maintained by <a href="http://twitter.com/ariyahidayat">Ariya Hidayat</a>,
+with the help of <a href="https://github.com/ariya/esprima/contributors">many contributors</a>.<br/>
+Follow <a href="http://twitter.com/Esprima">@Esprima</a> on Twitter to get the development updates.
</div>
</div>
<a href="http://github.com/ariya/esprima"><img style="position: absolute; top: 0; right: 0; border: 0;" src="assets/forkme_right_red_aa0000.png" alt="Fork me on GitHub"></a>

0 comments on commit 8312cc5

Please sign in to comment.