forked from ChainSafe/metamask-snap-polkadot
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
20 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,30 @@ | ||
# Metamask Polkadot & Substrate Snap | ||
# Polkadot Wallet Snap for MetaMask | ||
|
||
![](https://github.com/chainsafe/metamask-snap-polkadot/workflows/ci/badge.svg) | ||
![](https://img.shields.io/github/issues-raw/chainsafe/metamask-snap-polkadot) | ||
![](https://img.shields.io/github/license/chainsafe/metamask-snap-polkadot) | ||
|
||
This project extends Metamask capabilities to include support for Polkadot, | ||
Kusama, and other Substrate- and FRAME-based blockchains in the Polkadot | ||
ecosystem. | ||
This project uses the [MetaMask Snaps](https://metamask.io/snaps/) framework to extend MetaMask | ||
capabilities to include support for Polkadot, Kusama, and other | ||
[Substrate](https://docs.substrate.io/)- and FRAME-based blockchains in the | ||
[Polkadot](https://www.polkadot.network/) ecosystem. | ||
|
||
## What are Snaps? | ||
#### Extension | ||
- `yarn install` | ||
- `yarn run demo` | ||
|
||
> Snaps is a system that allows anyone to safely extend the capabilities of | ||
> MetaMask. A snap is a program that [Metamask runs] in an isolated environment | ||
> that can customize the wallet experience. | ||
> | ||
> For example, a snap can add new APIs to MetaMask, add support for different | ||
> blockchain protocols, or modify existing functionality using internal APIs. | ||
> Snaps is a new way to create web3 end user experiences, by modifying MetaMask | ||
> in ways that were impossible before. | ||
|
||
Learn more about snaps from the | ||
[official Metamask documentation](https://docs.metamask.io/guide/snaps.html). | ||
### License | ||
Copyright [2020] [ChainSafe Systems] | ||
|
||
**As of 2022-10-01, snaps are only supported in | ||
[Metamask's developer build, Flask](https://metamask.io/flask/).** | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
## Documentation | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Go to the [wiki](https://github.com/chainsafe/metamask-snap-polkadot/wiki) to | ||
learn morea about using this snap. | ||
|
||
The wiki also describes the | ||
[integration process](https://github.com/chainsafe/metamask-snap-polkadot/wiki#integration) | ||
and provides full | ||
[API documentation](https://github.com/chainsafe/metamask-snap-polkadot/wiki/API-Documentation) | ||
for dApp developers. | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters