Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
HenryQW committed Oct 31, 2023
1 parent ef5b19b commit 50a4694
Show file tree
Hide file tree
Showing 4 changed files with 69 additions and 55 deletions.
32 changes: 23 additions & 9 deletions packages/snap/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,26 @@
# TypeScript Example Snap
<!-- markdownlint-disable -->
<p align="center">
<a href="https://rss3.io" target="_blank" rel="noopener noreferrer">
<img width="180" src="doc/RSS3.svg" alt="RSS3 logo">
</a>
</p>
<p align="center">
<a href="https://npmjs.com/package/@rss3/social-notifier-snap"><img src="https://img.shields.io/npm/v/%40rss3%2Fsocial-notifier-snap?style=flat&logo=npm&color=%230072ff" alt="npm package"></a>
<a href="https://twitter.com/intent/follow?screen_name=rss3_"><img src="https://img.shields.io/twitter/follow/rss3_?color=%230072ff" alt="follow RSS3 on X"></a>
<a href="https://discord.gg/vfhpMjdbGU"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord&color=%230072ff" alt="discord chat"></a>
</p>
<!-- markdownlint-enable -->

This snap demonstrates how to develop a snap with TypeScript. It is a simple
snap that displays a confirmation dialog when the `hello` JSON-RPC method is
called.
# RSS3 Social Notifier Snap

## Testing
This MetaMask Snap offers a quick and easy way to stay on top of your frens' social activities.

The snap comes with some basic tests, to demonstrate how to write tests for
snaps. To test the snap, run `yarn test` in this directory. This will use
[`@metamask/snaps-jest`](https://github.com/MetaMask/snaps/tree/main/packages/snaps-jest)
to run the tests in `src/index.test.ts`.
Powered by RSS3's social aggretation capability, a truly platform-agnostic way to aggregate social activities from multiple social graphs.

## Getting Started

Simply visit <snap.rss3.io> and install the Snap.

Permissionless, no registation required.

For more information on MetaMASK Snap: <https://metamask.io/snaps/>
4 changes: 2 additions & 2 deletions packages/snap/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "rss3-metamask-snap",
"name": "@rss3/social-notifier-snap",
"version": "0.1.0",
"description": "Get notifications when your Web3 frens produce new activities.",
"repository": {
"type": "git",
"url": "https://github.com/NaturalSelectionLabs/RSS3-MetaMask-Snap.git"
"url": "https://github.com/NaturalSelectionLabs/RSS3-Social-Notifier-Snap.git"
},
"license": "Apache-2.0",
"main": "./dist/bundle.js",
Expand Down
6 changes: 3 additions & 3 deletions packages/snap/snap.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
"proposedName": "RSS3 Social Notifier",
"repository": {
"type": "git",
"url": "https://github.com/NaturalSelectionLabs/RSS3-MetaMask-Snap.git"
"url": "https://github.com/NaturalSelectionLabs/RSS3-Social-Notifier-Snap.git"
},
"source": {
"shasum": "otV0CuKpgG18gqS4SPVejZdu0OtF7aN9RmFrx13s674=",
"shasum": "OL1G7QqcS044uW1IkkyypXcKT93wsRBH9C7hCghRVrU=",
"location": {
"npm": {
"filePath": "dist/bundle.js",
"iconPath": "images/icon.svg",
"packageName": "rss3-metamask-snap",
"packageName": "@rss3/social-notifier-snap",
"registry": "https://registry.npmjs.org/"
}
}
Expand Down
82 changes: 41 additions & 41 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -6114,6 +6114,47 @@ __metadata:
languageName: node
linkType: hard

"@rss3/social-notifier-snap@workspace:packages/snap":
version: 0.0.0-use.local
resolution: "@rss3/social-notifier-snap@workspace:packages/snap"
dependencies:
"@jest/globals": ^29.5.0
"@lavamoat/allow-scripts": ^2.0.3
"@metamask/auto-changelog": ^2.6.0
"@metamask/eslint-config": ^10.0.0
"@metamask/eslint-config-jest": ^10.0.0
"@metamask/eslint-config-nodejs": ^10.0.0
"@metamask/eslint-config-typescript": ^10.0.0
"@metamask/snaps-cli": ^2.0.1
"@metamask/snaps-jest": ^1.0.0
"@metamask/snaps-types": ^2.0.0
"@metamask/snaps-ui": ^2.0.0
"@metamask/utils": ^8.1.0
"@rss3/js-sdk": ^0.6.38
"@typescript-eslint/eslint-plugin": ^5.33.0
"@typescript-eslint/parser": ^5.33.0
"@urql/core": ^4.1.4
buffer: ^6.0.3
cross-fetch: ^4.0.0
eslint: ^8.21.0
eslint-config-prettier: ^8.1.0
eslint-plugin-import: ^2.26.0
eslint-plugin-jest: ^26.8.2
eslint-plugin-jsdoc: ^39.2.9
eslint-plugin-node: ^11.1.0
eslint-plugin-prettier: ^4.2.1
ethers: ^6.7.1
jest: ^29.5.0
moment: ^2.29.4
prettier: ^2.2.1
prettier-plugin-packagejson: ^2.2.11
rimraf: ^3.0.2
through2: ^4.0.2
ts-jest: ^29.1.0
typescript: ^4.7.4
languageName: unknown
linkType: soft

"@scure/base@npm:^1.0.0, @scure/base@npm:^1.1.1, @scure/base@npm:^1.1.3, @scure/base@npm:~1.1.0, @scure/base@npm:~1.1.3":
version: 1.1.3
resolution: "@scure/base@npm:1.1.3"
Expand Down Expand Up @@ -20709,47 +20750,6 @@ __metadata:
languageName: node
linkType: hard

"rss3-metamask-snap@workspace:packages/snap":
version: 0.0.0-use.local
resolution: "rss3-metamask-snap@workspace:packages/snap"
dependencies:
"@jest/globals": ^29.5.0
"@lavamoat/allow-scripts": ^2.0.3
"@metamask/auto-changelog": ^2.6.0
"@metamask/eslint-config": ^10.0.0
"@metamask/eslint-config-jest": ^10.0.0
"@metamask/eslint-config-nodejs": ^10.0.0
"@metamask/eslint-config-typescript": ^10.0.0
"@metamask/snaps-cli": ^2.0.1
"@metamask/snaps-jest": ^1.0.0
"@metamask/snaps-types": ^2.0.0
"@metamask/snaps-ui": ^2.0.0
"@metamask/utils": ^8.1.0
"@rss3/js-sdk": ^0.6.38
"@typescript-eslint/eslint-plugin": ^5.33.0
"@typescript-eslint/parser": ^5.33.0
"@urql/core": ^4.1.4
buffer: ^6.0.3
cross-fetch: ^4.0.0
eslint: ^8.21.0
eslint-config-prettier: ^8.1.0
eslint-plugin-import: ^2.26.0
eslint-plugin-jest: ^26.8.2
eslint-plugin-jsdoc: ^39.2.9
eslint-plugin-node: ^11.1.0
eslint-plugin-prettier: ^4.2.1
ethers: ^6.7.1
jest: ^29.5.0
moment: ^2.29.4
prettier: ^2.2.1
prettier-plugin-packagejson: ^2.2.11
rimraf: ^3.0.2
through2: ^4.0.2
ts-jest: ^29.1.0
typescript: ^4.7.4
languageName: unknown
linkType: soft

"run-applescript@npm:^5.0.0":
version: 5.0.0
resolution: "run-applescript@npm:5.0.0"
Expand Down

0 comments on commit 50a4694

Please sign in to comment.