Skip to content

Commit 54d2b1c

Browse files
authored
docs: fix JSON example in versioning section (#5)
1 parent 6814e00 commit 54d2b1c

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,21 @@ This monorepo contains the NFDomains SDK for direct on-chain interaction with NF
77
This SDK is in early development (pre-1.0.0) and may introduce breaking changes despite our best efforts to avoid them. We recommend pinning the version in your package.json:
88

99
```json
10-
"@txnlab/nfd-sdk": "0.1.2" // instead of "@txnlab/nfd-sdk": "^0.1.2"
10+
{
11+
"dependencies": {
12+
"@txnlab/nfd-sdk": "0.1.2"
13+
}
14+
}
15+
```
16+
17+
Instead of using caret versioning:
18+
19+
```json
20+
{
21+
"dependencies": {
22+
"@txnlab/nfd-sdk": "^0.1.2"
23+
}
24+
}
1125
```
1226

1327
Once we reach v1.0.0 with all planned features, breaking changes will only be introduced via major version bumps following semantic versioning.

0 commit comments

Comments
 (0)