Skip to content
This repository has been archived by the owner on Dec 21, 2021. It is now read-only.

README rewrite for DU functions #222

Merged
merged 9 commits into from
Mar 15, 2021
Merged

README rewrite for DU functions #222

merged 9 commits into from
Mar 15, 2021

Conversation

jtakalai
Copy link
Contributor

@jtakalai jtakalai commented Mar 15, 2021

Updated the DU function docs to reflect the fact that we now have the DataUnion object (examples rewritten)

Also general cleanup. Please add freely to it where you see shortcomings.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@teogeb teogeb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good improvements! Could also say that DU methods returns their values in Promises if that is not 100% clear.

README.md Outdated Show resolved Hide resolved
README.md Outdated
const client = new StreamrClient({
auth: { privateKey },
})

const dataUnion = await client.deployDataUnion()
await client.setAdminFee(0.3, { dataUnion })
const receipt = await dataUnion.setAdminFee(0.3, { dataUnion })
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second parameter (({ dataUnion }) has been removed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it has in fact been removed ;) #224

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or about to be

Copy link
Contributor

@teogeb teogeb Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In #224 you remove option for another method (addMembers, removeMembers), I removed setAdminFee parameter earlier (but forgot to update this README).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here

jtakalai and others added 2 commits March 15, 2021 15:05
Co-authored-by: Matthew <fonty1@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@fonty1 fonty1 merged commit e688130 into master Mar 15, 2021
@fonty1 fonty1 deleted the du-readme-rewrite branch March 15, 2021 16:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants