Skip to content

Commit

Permalink
Initial repository setup (#5)
Browse files Browse the repository at this point in the history
The package manifest, README, and PR template have been updated.
  • Loading branch information
Gudahtt authored Feb 9, 2023
1 parent 8a2290f commit 504a752
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,3 @@ Are there any issues or other links reviewers should consult to understand this
* Fixes #12345
* See: #67890
-->

## Examples

<!--
Are there any examples of this change being used in another repository?
When considering changes to the MetaMask module template, it's strongly preferred that the change be experimented with in another repository first. This gives reviewers a better sense of how the change works, making it less likely the change will need to be reverted or adjusted later.
-->
2 changes: 1 addition & 1 deletion merged-packages/eth-json-rpc-provider/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

[Unreleased]: https://github.com/MetaMask/metamask-module-template/
[Unreleased]: https://github.com/MetaMask/eth-json-rpc-provider/
33 changes: 8 additions & 25 deletions merged-packages/eth-json-rpc-provider/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,21 @@
# MetaMask Module Template
# eth-json-rpc-provider

This TypeScript module is maintained in the style of the MetaMask team.

## Template Instructions

Follow these instructions when using this template.

- Update the package name
- The package name is referenced in the following places:
- The `name` field of `package.json`
- The README title
- The README "Usage" section
- Update the package description
- The package description is referenced at the beginning of the README, and in the `description` field of `package.json`.
- Update the `repository` field of `package.json` to point at the new repository URL.
- Update the pull request template (`.github/pull_request_template.md`) to remove the `Examples` section that is specific to this template.
- Update the README "Usage" and "API" sections, removing them if they aren't needed.
- Delete these instructions.
This package provides functions for creating an Ethereum provider from a [JSON-RPC engine](https://github.com/MetaMask/json-rpc-engine), or from middleware compatible with JSON-RPC engine.

## Installation

`yarn add @metamask/this-module`
`yarn add @metamask/eth-json-rpc-provider`

or

`npm install @metamask/this-module`

## Usage

_Add examples here_
`npm install @metamask/eth-json-rpc-provider`

## API

_Add examples here_
See our documentation:

- [Latest published API documentation](https://metamask.github.io/eth-json-rpc-provider/latest/)
- [Latest development API documentation](https://metamask.github.io/eth-json-rpc-provider/staging/)

## Contributing

Expand Down
8 changes: 4 additions & 4 deletions merged-packages/eth-json-rpc-provider/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@metamask/module-template",
"version": "0.0.0",
"description": "The MetaMask Node module template.",
"name": "@metamask/eth-json-rpc-provider",
"version": "1.0.0",
"description": "Create an Ethereum provider using a JSON-RPC engine or middleware",
"repository": {
"type": "git",
"url": "https://github.com/MetaMask/metamask-module-template.git"
"url": "https://github.com/MetaMask/eth-json-rpc-provider.git"
},
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
4 changes: 2 additions & 2 deletions merged-packages/eth-json-rpc-provider/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1293,9 +1293,9 @@ __metadata:
languageName: node
linkType: hard

"@metamask/module-template@workspace:.":
"@metamask/eth-json-rpc-provider@workspace:.":
version: 0.0.0-use.local
resolution: "@metamask/module-template@workspace:."
resolution: "@metamask/eth-json-rpc-provider@workspace:."
dependencies:
"@lavamoat/allow-scripts": ^2.0.3
"@metamask/auto-changelog": ^3.1.0
Expand Down

0 comments on commit 504a752

Please sign in to comment.