Skip to content

Update sample so it works when copied & pasted into an empty file #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2023
Merged

Update sample so it works when copied & pasted into an empty file #65

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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).

Expand Down