Skip to content

Commit 25cfb80

Browse files
committed
docs(issuance): add README and remove LICENSE reference
- Add README.md with package documentation including setup, build, test, and lint commands - Remove LICENSE from package.json files array (consistent with majority of packages; root LICENSE covers monorepo)
1 parent 65f0947 commit 25cfb80

File tree

2 files changed

+57
-2
lines changed

2 files changed

+57
-2
lines changed

packages/issuance/README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# The Graph Issuance Contracts
2+
3+
This package contains smart contracts for The Graph's issuance functionality.
4+
5+
## Overview
6+
7+
The issuance contracts handle token issuance mechanisms for The Graph protocol.
8+
9+
## Development
10+
11+
### Setup
12+
13+
```bash
14+
# Install dependencies
15+
pnpm install
16+
17+
# Build
18+
pnpm build
19+
20+
# Test
21+
pnpm test
22+
```
23+
24+
### Testing
25+
26+
To run the tests:
27+
28+
```bash
29+
pnpm test
30+
```
31+
32+
For coverage:
33+
34+
```bash
35+
pnpm test:coverage
36+
```
37+
38+
### Linting
39+
40+
To lint the contracts and tests:
41+
42+
```bash
43+
pnpm lint
44+
```
45+
46+
### Contract Size
47+
48+
To check contract sizes:
49+
50+
```bash
51+
pnpm size
52+
```
53+
54+
## License
55+
56+
GPL-2.0-or-later

packages/issuance/package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@
3333
"artifacts/**/*",
3434
"types/**/*",
3535
"contracts/**/*",
36-
"README.md",
37-
"LICENSE"
36+
"README.md"
3837
],
3938
"author": "The Graph Team",
4039
"license": "GPL-2.0-or-later",

0 commit comments

Comments
 (0)