Permalink
Browse files

Clean up a few typos and grammar.

  • Loading branch information...
1 parent 3472e10 commit da6a6717b19ca91347049c4e63c30e510575b8dc @jasondavies jasondavies committed with indutny Aug 30, 2012
Showing with 12 additions and 13 deletions.
  1. +12 −13 README.md
View
25 README.md
@@ -8,7 +8,7 @@
## OMetaJS [![Build Status](https://secure.travis-ci.org/veged/ometa-js.png)](http://travis-ci.org/veged/ometa-js)
-OMetaJS is a JavaScript implementation of the OMeta, an object-oriented language
+OMetaJS is a JavaScript implementation of OMeta, an object-oriented language
for pattern matching.
This is a *node.js* module for developing and using such pattern matching
@@ -28,7 +28,7 @@ $ curl http://npmjs.org/install.sh | sh
$ [sudo] npm install ometajs -g
```
-**Note:** If you are using ometajs _programatically_ you should not install
+**Note:** If you are using ometajs _programmatically_ you should not install
it globally.
``` bash
@@ -55,21 +55,20 @@ Options:
--root=ROOT : Path to root module (default: ometajs)
```
-`ometajs2js` will take input `*.ometajs` file and produce [CommonJS][0]
+`ometajs2js` will take input `*.ometajs` file and produce a [CommonJS][0]-
compatible javascript file.
-Also you may `require('*.ometajs')` files directly without compilation.
-(OmetaJS is patching `require.extensions` as [CoffeeScript][1] does).
+You may also `require('*.ometajs')` files directly without compilation.
+(OMetaJS is patching `require.extensions` as [CoffeeScript][1] does).
-### Using as CommonJS module
+### Usage as CommonJS module
```javascript
var ometajs = require('ometajs');
var ast = ometajs.grammars.BSJSParser.matchAll('var x = 1', 'topLevel'),
code = ometajs.grammars.BSJSTranslator.matchAll([ast], 'trans');
```
-Example
### Example grammar
@@ -79,25 +78,25 @@ ometa Simple {
}
```
-[More information][5] about OmetaJS syntax.
+[More information][5] about OMetaJS syntax.
### Use cases
-Fast prototyping and building your own parser/language. Processing/traversing
-complex [AST][2].
+Quickly prototype and buildyour own parser/language. Process/traverse complex
+[AST][2].
-Some projects that are using this:
+Some projects that are using OMetaJS:
- [XJST](http://github.com/veged/xjst)
- [ShmakoWiki](http://github.com/veged/shmakowiki/)
- [OmetaHighlighter](http://github.com/veged/ometa-highlighter)
### More information
-To study OmetaJS or ask questions about it's core you can try to reach out
+To study OMetaJS or ask questions about its core you can reach out to the
[original repository][3] author [Alessandro Warth][4] or me.
-Here is [documented code][5].
+Here is the [documented code][5].
#### Contributors

0 comments on commit da6a671

Please sign in to comment.