Skip to content

Commit 670647f

Browse files
committed
prepped for npm release
1 parent 737f0ed commit 670647f

File tree

3 files changed

+98
-0
lines changed

3 files changed

+98
-0
lines changed

.npmignore

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Development and build files
2+
test/
3+
script/
4+
.github/
5+
6+
# Build artifacts
7+
cache/
8+
out/
9+
broadcast/
10+
lib/
11+
12+
# Deployment files
13+
deployment/
14+
15+
# Documentation and releases
16+
README.md
17+
docs/
18+
releases/
19+
20+
# Configuration files
21+
foundry.toml
22+
remappings.txt
23+
Makefile
24+
slither.config.json
25+
26+
# Git files
27+
.git/
28+
.gitignore
29+
.gitmodules
30+
.gitattributes
31+
32+
# IDE and OS files
33+
.vscode/
34+
.DS_Store
35+
36+
# Environment files
37+
.env
38+
.env.*
39+
40+
# Node modules (if any)
41+
node_modules/
42+
43+
# Keystore
44+
keystore/

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,31 @@ This list contains the deployment info for the versions that we are currently su
4040
- [Current](./releases/next/NOTE.md)
4141
- [v1.0.0](./releases/v1.0.0/NOTE.md)
4242

43+
---
44+
45+
### Integration
46+
47+
To install the Automata Onchain PCCS contracts as a dependency for your project, you can either run:
48+
49+
```bash
50+
forge install automata-network/automata-on-chain-pccs
51+
```
52+
OR
53+
54+
```bash
55+
npm install @automata-network/on-chain-pccs
56+
```
57+
58+
If you are using Foundry, make sure to include the following to your remappings:
59+
60+
```text
61+
# Foundry Submodule:
62+
automata-network/on-chain-pccs/=lib/automata-on-chain-pccs/src/
63+
64+
# NPM
65+
automata-network/on-chain-pccs/=node_modules/@automata-network/on-chain-pccs/src/
66+
```
67+
4368
---
4469

4570
### #BUIDL 🛠️

package.json

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"name": "@automata-network/on-chain-pccs",
3+
"version": "1.1.0",
4+
"description": "On-chain PCCS for Intel DCAP attestation - Solidity smart contracts",
5+
"author": "Automata Network",
6+
"license": "MIT",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/automata-network/automata-on-chain-pccs.git"
10+
},
11+
"keywords": [
12+
"solidity",
13+
"smart-contracts",
14+
"attestation",
15+
"dcap",
16+
"intel",
17+
"sgx",
18+
"tdx",
19+
"pccs"
20+
],
21+
"files": [
22+
"src",
23+
"LICENSE"
24+
],
25+
"peerDependencies": {
26+
"@openzeppelin/contracts": "5.0.2",
27+
"solady": "0.0.160"
28+
}
29+
}

0 commit comments

Comments
 (0)