diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f4d54fd..67d6a44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,5 +4,5 @@ We welcome contributions to the FireFly Project in many forms, and there's always plenty to do! Please visit the -[contributors guide](https://hyperledger.github.io/firefly/contributors/contributors.html) in the +[contributors guide](https://hyperledger.github.io/firefly/contributors/index.html) in the docs to learn how to make contributions to this exciting project. diff --git a/README.md b/README.md index e81b106..d3adec9 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,24 @@ npm install @hyperledger/firefly-sdk ```typescript import FireFly from '@hyperledger/firefly-sdk'; -const firefly = new FireFly({ host: 'http://localhost:5000' }); -await firefly.sendBroadcast({ - data: [{ value: 'test-message' }], -}); +async function main() { + const firefly = new FireFly({ host: 'http://localhost:5000' }); + await firefly.sendBroadcast({ + data: [ + { + value: 'test-message', + }, + ], + }); +} + +if (require.main === module) { + main().catch((err) => console.error(`Error: ${err}`)); +} ``` +(This example was taken from the [examples](examples) folder where you will find some other basic samples) + ## Generated schemas The types for FireFly requests and responses are generated from the OpenAPI schema for FireFly. If you have @@ -47,7 +59,7 @@ that may be helpful to reference: Interested in contributing to the community? -Check out our [Contributor Guide](https://hyperledger.github.io/firefly/contributors/contributors.html), and welcome! +Check out our [Contributor Guide](https://hyperledger.github.io/firefly/contributors/index.html), and welcome! Please adhere to this project's [Code of Conduct](CODE_OF_CONDUCT.md).