Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor documentation request #6

Open
nealeyoung opened this issue Feb 23, 2014 · 0 comments
Open

minor documentation request #6

nealeyoung opened this issue Feb 23, 2014 · 0 comments

Comments

@nealeyoung
Copy link

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

<script src="pegjs-coffee-plugin.js"></script>

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant