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

Add a quickstart guide to documentation #210

Open
johnthagen opened this issue Jan 14, 2022 · 1 comment
Open

Add a quickstart guide to documentation #210

johnthagen opened this issue Jan 14, 2022 · 1 comment

Comments

@johnthagen
Copy link

johnthagen commented Jan 14, 2022

For new users transitioning to crypto-browserify (for example due to recent create-react-scripts 5 breakage), it would be really helpful if the user guide had a small example of how to:

  • Install crypto-browserify and configure package.json
  • How to import and use the package

For example, treating this like a normal npm package, I expected that this could work:

  "dependencies": {
    "crypto-browserify": "^3.12.0",
import hash from "crypto-browserify";

But it does not. Likely this needs to be patched over the "crypto" namespace, but having explicit instructions for this would be helpful.

@m12lrpv
Copy link

m12lrpv commented Jul 15, 2022

If no one can use it due to lack of documentation then there really isn't any point in it existing.

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

2 participants