Skip to content

Commit

Permalink
Update @metamask/json-rpc-engine README to reflect migration into m…
Browse files Browse the repository at this point in the history
…onorepo subpackage (#1990)

## Explanation

Adds an "Installation" and "Contributing" section to the `@metamask/json-rpc-engine` README, as it has been migrated into the monorepo.

In future migrations, this step will be performed in "Phase B" (see #1551 (comment)), while the package is being staged in the `merged-packages/` temporary directory.

## References

- Partially implements #1981.

## Changelog

N/A
  • Loading branch information
MajorLift authored Nov 7, 2023
1 parent 75b73c2 commit 9342a1a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions packages/json-rpc-engine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

A tool for processing JSON-RPC requests and responses.

## Installation

`yarn add @metamask/json-rpc-engine`

or

`npm install @metamask/json-rpc-engine`

## Usage

```js
Expand Down Expand Up @@ -191,14 +199,6 @@ engine.push(function (req, res, next, end) {
});
```

## Running tests
## Contributing

Build the project if not already built:

```bash
yarn build
```

```bash
yarn test
```
This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

0 comments on commit 9342a1a

Please sign in to comment.