optimize npm registry packaging (#41)

* feat: optimize npm registry packaging

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 The Azuki Company
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,7 @@
 ## PBT (Physical Backed Token)
 
+[![npm](https://img.shields.io/npm/v/@chiru-labs/pbt)](https://www.npmjs.com/package/@chiru-labs/pbt)
+
 NFT collectors enjoy collecting digital assets and sharing them with others online. However, there is currently no such standard for showcasing physical assets as NFTs with verified authenticity and ownership. Existing solutions are fragmented and tend to be susceptible to at least one of the following:
 
 - The NFT cannot proxy as ownership of the physical item. In most current implementations, the NFT and physical item are functionally two decoupled distinct assets after the NFT mint, in which the NFT can be freely traded independently from the physical item.
@@ -13,6 +15,20 @@ From the [Azuki](https://twitter.com/Azuki) team.
 
 Note: the frontend library for chip signatures can be found [here](https://github.com/chiru-labs/pbt-chip-client).
 
+## Import Into Your Project
+
+### Hardhat
+
+```
+npm install @chiru-labs/pbt
+```
+
+### Foundry
+
+```
+forge install https://github.com/chiru-labs/PBT
+```
+
 ## Resources
 
 - [pbt.io](https://www.pbt.io/)

package.json

@@ -1,18 +1,17 @@
 {
-    "name": "@chiru-labs/pbt",
-    "version": "0.3.0",
-    "description": "Physically Backed Token Contracts in Solidity",
-    "main": "index.js",
-    "files": [
-        "/src/**/*.sol"
-    ],
-    "dependencies": {
-        "@openzeppelin/contracts": "^4.7.3"
-    },
-    "repository": {
-        "type": "git",
-        "url": "[email protected]:chiru-labs/PBT.git"
-    },
-    "author": "chiru-labs",
-    "license": "MIT"
+  "name": "@chiru-labs/pbt",
+  "version": "0.3.0",
+  "description": "Contracts for Physical Backed Tokens (ERC-5791). ",
+  "files": [
+    "/src/**/*.sol"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "[email protected]:chiru-labs/PBT.git"
+  },
+  "author": "chiru-labs",
+  "license": "MIT",
+  "dependencies": {
+    "@chiru-labs/pbt": "^0.3.0"
+  }
 }