browserify / crypto-browserify

partial implementation of node's `crypto` for the browser
MIT License
653 stars 199 forks source link

Add a quickstart guide to documentation #210

Open johnthagen opened 2 years ago

johnthagen commented 2 years ago

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:

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 commented 2 years ago

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