Skip to content

Commit

Permalink
chore!: change algosdk to peer dependency (#107)
Browse files Browse the repository at this point in the history
BREAKING CHANGE: algosdk is now a peer dependency. This package should now be installed as a dependency in all projects that use algokit-utils-ts.
  • Loading branch information
negar-abbasi authored Aug 30, 2023
1 parent eacd211 commit 80d501f
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 12 deletions.
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ This library can be installed from NPM using your favourite npm client, e.g.:
npm install @algorandfoundation/algokit-utils
```

## Peer Dependencies

This library requires `algosdk` as a peer dependency. Ensure you have it installed in your project.

# Usage

To use this library simply include the following at the top of your file:
Expand Down
35 changes: 26 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,12 @@
"eslint-plugin-prettier": "5.0.0"
},
"dependencies": {
"algosdk": "^2.5.0",
"buffer": "^6.0.3",
"cross-fetch": "^4.0.0"
},
"peerDependencies": {
"algosdk": "^2.5.0"
},
"devDependencies": {
"@commitlint/cli": "^17.7.1",
"@commitlint/config-conventional": "^17.7.0",
Expand All @@ -81,6 +83,8 @@
"@tsconfig/node16": "^16.1.0",
"@types/jest": "^29.5.2",
"@types/uuid": "^9.0.2",
"algosdk": "^2.5.0",
"better-npm-audit": "^3.7.3",
"conventional-changelog-conventionalcommits": "^6.0.0",
"copyfiles": "^2.4.1",
"dotenv-cli": "^7.3.0",
Expand All @@ -95,8 +99,7 @@
"typedoc": "^0.24.8",
"typedoc-plugin-markdown": "^3.15.4",
"typescript": "^5.1.3",
"uuid": "^9.0.0",
"better-npm-audit": "^3.7.3"
"uuid": "^9.0.0"
},
"release": {
"branches": [
Expand Down

0 comments on commit 80d501f

Please sign in to comment.