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

README and examples issues #11

Open
5 tasks
pietrop opened this issue Sep 18, 2019 · 1 comment
Open
5 tasks

README and examples issues #11

pietrop opened this issue Sep 18, 2019 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@pietrop
Copy link
Contributor

pietrop commented Sep 18, 2019

A good list of things to sort out in the README and rest of the repo by @gridinoc

  • 1. const alignJSONText = require('./index.js'); -> no index.js, if you require src/index.js still dies as there is no function exported by default
  • 2. "See /lib/example-usage for an example that you can run with npm run example." there is no /lib
  • 3. babel-loader and gh-pages should be devDependencies
  • 4. the demo is useless, I get a page asking for files I don't have
  • 5. package.json: "main": "lib/index.js", well, no /lib again

Leaving it as a note for when I get a chance to do a PR

@pietrop pietrop added the bug Something isn't working label Sep 18, 2019
@Laurian
Copy link
Contributor

Laurian commented Jan 10, 2020

Note that if npm install fails on macOS Catalina, run first npm i -g node-gyp@latest && npm config set node_gyp "/usr/local/lib/node_modules/node-gyp/bin/node-gyp.js" see nodejs/node-gyp#1779 (comment)

@Laurian Laurian self-assigned this Sep 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants