ohm-js 17.0.3 → 17.1.0-pre

package/README.md

@@ -1,4 +1,4 @@
-# [Ohm](https://ohmjs.org/) · [![NPM](https://img.shields.io/npm/v/ohm-js.svg)](https://www.npmjs.com/package/ohm-js) ![Node.js CI](https://github.com/harc/ohm/workflows/Node.js%20CI/badge.svg?style=flat-square) [![Chat on Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/KwxY5gegRQ)
+# [Ohm](https://ohmjs.org/) · [![NPM](https://img.shields.io/npm/v/ohm-js.svg)](https://www.npmjs.com/package/ohm-js) ![Node.js CI](https://github.com/ohmjs/ohm/workflows/Node.js%20CI/badge.svg?style=flat-square) [![Chat on Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/KwxY5gegRQ)
 
 Ohm is a parsing toolkit consisting of a library and a domain-specific language. You can use it to parse custom file formats or quickly build parsers, interpreters, and compilers for programming languages.
 
@@ -31,10 +31,10 @@ The easiest way to get started with Ohm is to use the [interactive editor](https
 ### Resources
 
 - Tutorial: [Ohm: Parsing Made Easy](https://nextjournal.com/dubroy/ohm-parsing-made-easy)
-- The [math example](examples/math/index.html) is extensively commented and is a good way to dive deeper.
-- [Examples](examples/)
+- The [math example](https://github.com/ohmjs/ohm/tree/main/examples/math/index.html) is extensively commented and is a good way to dive deeper.
+- [Examples](https://github.com/ohmjs/ohm/tree/main/examples/)
 - [Documentation](doc/README.md)
-- For community support and discussion, join us on [Discord](https://discord.gg/KwxY5gegRQ), [GitHub Discussions](https://github.com/harc/ohm/discussions), or the [ohm-discuss mailing list](https://groups.google.com/u/0/g/ohm-discuss).
+- For community support and discussion, join us on [Discord](https://discord.gg/KwxY5gegRQ), [GitHub Discussions](https://github.com/ohmjs/ohm/discussions), or the [ohm-discuss mailing list](https://groups.google.com/u/0/g/ohm-discuss).
 - For updates, follow [@\_ohmjs on Twitter](https://twitter.com/_ohmjs).
 
 ### Installation
@@ -45,14 +45,14 @@ To use Ohm in the browser, just add a single `<script>` tag to your page:
 
 ```html
 <!-- Development version of Ohm from unpkg.com -->
-<script src="https://unpkg.com/ohm-js@16/dist/ohm.js"></script>
+<script src="https://unpkg.com/ohm-js@17/dist/ohm.js"></script>
 ```
 
 or
 
 ```html
 <!-- Minified version, for faster page loads -->
-<script src="https://unpkg.com/ohm-js@16/dist/ohm.min.js"></script>
+<script src="https://unpkg.com/ohm-js@17/dist/ohm.min.js"></script>
 ```
 
 This creates a global variable named `ohm`.
@@ -75,10 +75,10 @@ Then, you can use `require` to use Ohm in a script:
 const ohm = require('ohm-js');
 ```
 
-As of v16.2.0, Ohm can also be imported as an ES module:
+Ohm can also be imported as an ES module:
 
 ```js
-import ohm from 'ohm-js';
+import * as ohm from 'ohm-js';
 ```
 
 #### Deno
@@ -86,14 +86,14 @@ import ohm from 'ohm-js';
 To use Ohm from [Deno](https://deno.land/):
 
 ```js
-import ohm from 'https://unpkg.com/ohm-js@16/dist/ohm.esm.js';
+import * as ohm from 'https://unpkg.com/ohm-js@17';
 ```
 
 ### Basics
 
 #### Defining Grammars
 
-![Instantiating a grammar](https://ohmjs.org/docs/images/instantiating-grammars.png)
+![Instantiating a grammar](https://ohmjs.org/img/docs/instantiating-grammars.png)
 
 To use Ohm, you need a grammar that is written in the Ohm language. The grammar provides a formal
 definition of the language or data format that you want to parse. There are a few different ways
@@ -131,7 +131,7 @@ For more information, see [Instantiating Grammars](doc/api-reference.md#instanti
 
 #### Using Grammars
 
-![Matching input](http://harc.github.io/ohm/doc/images/matching.png)
+![Matching input](https://ohmjs.org/img/docs/matching.png)
 
 <!-- @markscript
   // The duplication here is required because Markscript only executes top-level code blocks.
@@ -159,11 +159,11 @@ For more information, see the [main documentation](doc/README.md).
 
 Ohm has two tools to help you debug grammars: a text trace, and a graphical visualizer.
 
-[![Ohm Visualizer](http://harc.github.io/ohm/doc/images/visualizer-small.png)](https://ohmjs.org/editor)
+[![Ohm Visualizer](https://ohmjs.org/img/docs/visualizer-small.png)](https://ohmjs.org/editor)
 
 You can [try the visualizer online](https://ohmjs.org/editor).
 
-To see the text trace for a grammar `g`, just use the [`g.trace()`](./doc/api-reference.md#trace)
+To see the text trace for a grammar `g`, just use the [`g.trace()`](doc/api-reference.md#trace)
 method instead of `g.match`. It takes the same arguments, but instead of returning a MatchResult
 object, it returns a Trace object — calling its `toString` method returns a string describing
 all of the decisions the parser made when trying to match the input. For example, here is the
@@ -203,4 +203,4 @@ our [suggestions for publishing grammars](./doc/publishing-grammars.md).
 ## Contributing to Ohm
 
 Interested in contributing to Ohm? Please read [CONTRIBUTING.md](./CONTRIBUTING.md)
-and the [Ohm Contributor Guide](./docs/contributing.md).
+and the [Ohm Contributor Guide](doc/contributing.md).