browserify / browserify/crypto-browserify

Add a quickstart guide to documentation

Open
#210 1 comment 12 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
681
Forks
209
PR merge metrics
No merged PRs in 30d

Description

For new users transitioning to `crypto-browserify` (for example due to recent [`create-react-scripts 5` breakage](https://github.com/facebook/create-react-app/pull/11764)), 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:

```json
"dependencies": {
"crypto-browserify": "^3.12.0",
```

```ts
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.

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.