Skip to content

Commit feec6c5

Browse files
authored
Merge pull request #95 from semiotic-ai/suchapalaver/docs/add-npm-badges
docs: add npm package badges to README
2 parents 1f7acdc + 0d957b7 commit feec6c5

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,46 @@
11
# Timeline Aggregation Protocol (TAP) Contract(s)
22

3+
[![npm version](https://badge.fury.io/js/@semiotic-labs%2Ftap-contracts-bindings.svg)](https://badge.fury.io/js/@semiotic-labs%2Ftap-contracts-bindings)
4+
[![npm downloads](https://img.shields.io/npm/dm/@semiotic-labs/tap-contracts-bindings.svg)](https://www.npmjs.com/package/@semiotic-labs/tap-contracts-bindings)
5+
[![License](https://img.shields.io/npm/l/@semiotic-labs/tap-contracts-bindings.svg)](https://www.npmjs.com/package/@semiotic-labs/tap-contracts-bindings)
6+
[![Dependencies](https://img.shields.io/librariesio/release/npm/@semiotic-labs/tap-contracts-bindings)](https://www.npmjs.com/package/@semiotic-labs/tap-contracts-bindings)
7+
38
## Create types and bindings
49

510
First, start [forge](https://book.getfoundry.sh/getting-started/installation). If you don't already have it installed, make sure you restart your shell.
611

7-
``` shell
12+
```terminal
813
foundryup
914
```
1015

1116
Next, build the smart contracts.
1217

13-
```
18+
```terminal
1419
yarn build
1520
```
1621

1722
Afterwards, enter the bindings directory:
1823

19-
```
24+
```terminal
2025
cd bindings
2126
```
2227

2328
And run the following commands to generate the types and bindings:
2429

25-
```
30+
```terminal
2631
yarn bindings
2732
yarn tsc
2833
```
2934

3035
With the bindings generated, you may publish to npm using the following command:
3136

32-
```
37+
```terminal
3338
npm publish
3439
```
3540

3641
You must have the relevant access permissions to publish this crate.
3742
You can check these by seeing whether `tap-contracts-bindings` is listed as `read-write` under
3843

39-
``` shell
44+
```terminal
4045
npm access list packages
4146
```

0 commit comments

Comments
 (0)