feat: more small text changes (#199)

ChainSafe · Oct 12, 2023 · e0f3d4f · e0f3d4f
1 parent d5375fc
commit e0f3d4f
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -9,12 +9,25 @@ 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.
 
-#### Extension
+## Documentation
+
+Polkadot Wallet snap architecture, integration steps and detailed API documentation for dApp
+developers is covered in the
+[project wiki](https://github.com/ChainSafe/metamask-snap-polkadot/wiki), which also includes a
+usage guide for the [example dApp](https://polkadot.snap.chainsafe.io/).
+
+## Local Development
+
+Developers who wish to use the snap locally must use [MetaMask Flask](https://metamask.io/flask/);
+run the following commands from the project root to launch the
+[Polkadot Wallet Snap Example dApp](https://github.com/ChainSafe/metamask-snap-polkadot/tree/master/packages/example).
+
 - `yarn install`
 - `yarn run demo`
 
 
-### License
+## License
+
 Copyright [2020] [ChainSafe Systems]
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -27,4 +40,4 @@ 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.
+limitations under the License.
diff --git a/packages/example/src/containers/MetaMaskConnector/MetaMaskConnector.tsx b/packages/example/src/containers/MetaMaskConnector/MetaMaskConnector.tsx
@@ -3,7 +3,7 @@ import CloseIcon from '@material-ui/icons/Close';
 import React, { Fragment, useCallback, useContext, useEffect } from 'react';
 import Alert from '@material-ui/lab/Alert';
 import { MetamaskActions, MetaMaskContext } from '../../context/metamask';
-import { initiatePolkdatodSnap, isPolkadotSnapInstalled } from '../../services/metamask';
+import { initiatePolkadotSnap, isPolkadotSnapInstalled } from '../../services/metamask';
 
 export const MetaMaskConnector = (): React.JSX.Element => {
   const [state, dispatch] = useContext(MetaMaskContext);
@@ -20,7 +20,7 @@ export const MetaMaskConnector = (): React.JSX.Element => {
   }, [dispatch]);
 
   const installSnap = useCallback(async (): Promise<void> => {
-    const installResult = await initiatePolkdatodSnap();
+    const installResult = await initiatePolkadotSnap();
     if (!installResult.isSnapInstalled) {
       dispatch({
         payload: {

diff --git a/packages/example/src/services/metamask.ts b/packages/example/src/services/metamask.ts
@@ -47,7 +47,7 @@ export interface SnapInitializationResponse {
   snap?: MetamaskPolkadotSnap;
 }
 
-export async function initiatePolkdatodSnap(): Promise<SnapInitializationResponse> {
+export async function initiatePolkadotSnap(): Promise<SnapInitializationResponse> {
   const snapId = process.env.REACT_APP_SNAP_ID ? process.env.REACT_APP_SNAP_ID : defaultSnapId;
 
   try {

diff --git a/packages/snap/README.md b/packages/snap/README.md
@@ -9,17 +9,28 @@ 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.
 
-#### Extension
+## Documentation
 
-Developers who wish to use the extension locally must use [MetaMask Flask](https://metamask.io/flask/);
+Polkadot Wallet snap architecture, integration steps and detailed API documentation for dApp
+developers is covered in the
+[project wiki](https://github.com/ChainSafe/metamask-snap-polkadot/wiki), which also includes a
+usage guide for the [example dApp](https://polkadot.snap.chainsafe.io/). Additional
+documentation is available on the
+[homepage](https://github.com/ChainSafe/metamask-snap-polkadot#polkadot-wallet-snap-for-metamask)
+for the project's GitHub repository.
+
+## Local Development
+
+Developers who wish to use the snap locally must use [MetaMask Flask](https://metamask.io/flask/);
 run the following commands from the project root to launch the
 [Polkadot Wallet Snap Example dApp](https://github.com/ChainSafe/metamask-snap-polkadot/tree/master/packages/example).
 
 - `yarn install`
 - `yarn run demo`
 
 
-### License
+## License
+
 Copyright [2020] [ChainSafe Systems]
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -32,4 +43,4 @@ 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.
+limitations under the License.