Skip to content

Commit

Permalink
docs: update links
Browse files Browse the repository at this point in the history
  • Loading branch information
ohager committed Dec 30, 2024
1 parent da8766a commit 900d864
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 8 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ technology.
- [X] STANDARDS
- [X] WALLET
- [X] DOCUMENTATION
- [ ] EXAMPLES
- [ ] MORE EXAMPLES

Version 2 is now live. There are some major changes especially for the crypto package. Check more details [here](./packages/crypto/README.md)
Consider this version as not fully stable yet.
Expand Down Expand Up @@ -120,7 +120,7 @@ Examples:
```js
// using core
const ledger = sig$.LedgerClientFactory.create({
nodeHost: "http://testnet.signum.network",
nodeHost: "https://europe3.testnet.signum.network",
});

ledger.network.getBlockchainStatus().then(console.log);
Expand Down Expand Up @@ -162,7 +162,7 @@ subscription.unlisten()
```ts
// using standards - depends on ledger
const ledger = sig$.LedgerClientFactory.create({
nodeHost: "http://europe3.testnet.signum.network",
nodeHost: "https://europe3.testnet.signum.network",
});

// create Descriptor data object
Expand Down Expand Up @@ -237,7 +237,7 @@ That's it!

## Building the packages

The SDK is using [Lerna](https://lerna.js.org/) to manage all subpackages in a developer friendlier way:
The SDK is using [Turborepo](https://turbo.build/) to manage all subpackages in a developer friendlier way:

```bash
npm run build
Expand All @@ -246,8 +246,7 @@ npm run build
## Running Tests

1. Single test run `npm run test`
2. Run in watch mode `npm run test:watch`
3. Run end-to-end test `npm run test:e2e`
2Run end-to-end test `npm run test:e2e`
| Keep in mind that these tests are slow as they run against true servers. And therefore, it cannot be guaranteed
that all E2E tests always work

Expand Down
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,4 @@ Just import the package using the HTML `<script>` tag.


See more here:
[@signumjs/core Online Documentation](https://signum-network.github.io/signumjs/module/core)
[@signumjs/core Online Documentation](https://signum-network.github.io/signumjs/modules/core.html)
2 changes: 1 addition & 1 deletion packages/crypto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ console.log(sig$crypto.sha256AsHex('test'))
```

See more here:
[@signumjs/crypto Online Documentation](https://signum-network.github.io/signumjs/module/crypto)
[@signumjs/crypto Online Documentation](https://signum-network.github.io/signumjs/modules/crypto.html)


## Crossplatform Usage
Expand Down

0 comments on commit 900d864

Please sign in to comment.