dignifiedquire / dignifiedquire/pegjs-coffee-plugin

minor documentation request

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
34
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Can you please add a short subsection under Usage (in the top-level documentation README.md) for usage within a browser? The README explains how to _install_ it via

```

```

but then there are no subsequent instructions in the usage section for _using it_ (in a browser).

As far as I've been able to figure out, loading the .js file sets the global variable PEGjsCoffeePlugin, so that I can use it in PEG.js by adding the following option to the PEG.buildParser call:

```
plugins: [PEGjsCoffeePlugin]
```

But the README does not mention the name "PEGjsCoffeePlugin", so this was not easy to figure out.

thanks, -Neal

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.