add README

mvc-labs · May 16, 2024 · 76f7411 · 76f7411
1 parent 8a35884
commit 76f7411
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 274 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,29 @@
+# MVC Resources
+
+## Overview
+
+This repository contains resources such as icons, logos, and other assets.
+
+We use unpkg service to serve these assets.
+
+To get the URL of an asset, use the provided `getAssetUrl` function.
+
+```ts:
+import { getIconUri } from '@mvc-org/mvc-resources'
+
+const uri = getIconUri({
+  type: 'metaContract',
+  codehash: 'a2421f1e90c6048c36745edd44fad682e8644693',
+  genesis: '94c2ae3fdbf95a4fb0d788c818cf5fcc7a9aa66a', // genesis for usdt
+})
+
+console.log(uri)
+// https://unpkg.com/@mvc-org/mvc-resources/icons/meta-contract/usdt.jpg
+```
+
+## To add a new asset
+
+- Fork this repository
+- Add the asset to the appropriate folder.
+- Add asset lookup rules to corresponding the rules file.
+- Create a pull request to the main repository and wait for approval. It will be published to unpkg after approval.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@mvc-org/mvc-resources",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "mvc resources cdn",
   "main": "dist/index.js",
   "files": [

diff --git a/src/index.js b/src/index.js
diff --git a/src/rules/metaContract.js b/src/rules/metaContract.js