status-im
/
dappconnect-vote-poll-sdk
mirror of https://github.com/status-im/dappconnect-vote-poll-sdk.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix some typos, add title to readmes

This commit is contained in:
Franck 2021-12-07 13:24:10 +11:00
parent 7bbbf573bb
commit a152432976
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
4 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
packages/example/README.md
View File

@ -1,4 +1 @@
# status-community-dapp # DappConnect Vote & Poll SDK Example
Community directory curator dApp for Status
Webpack for hosting polling and proposal apps

4
packages/poll-example/README.md
View File

@ -1,3 +1,5 @@
# DappConnect Poll SDK Example
This package is example usage of WakuPolling This package is example usage of WakuPolling
Example uses usedapp for exposing web3 provider Example uses usedapp for exposing web3 provider
@ -67,4 +69,4 @@ Waku polling also exposes `getDetailedTimedPolls`
``` ```
const DetailedTimedPolls = await wakuPolling.getDetailedTimedPolls() const DetailedTimedPolls = await wakuPolling.getDetailedTimedPolls()
``` ```

4
packages/poll-react-hooks/README.md
View File

@ -1,7 +1,7 @@
Package contains react hooks that help with memoizing values Package contains react hooks that help with memorizing values
## hooks ## hooks
-`usePollList(wakuPolling: WakuPolling | undefined)` returns array of DetailedTimedPoll of polls on waku network -`usePollList(wakuPolling: WakuPolling | undefined)` returns array of DetailedTimedPoll of polls on waku network
-`useWakuPolling(appName: string, tokenAddress: string, provider: Web3Provider | undefined, multicallAddress: string | undefined)` returns meoized WakuPolling object -`useWakuPolling(appName: string, tokenAddress: string, provider: Web3Provider | undefined, multicallAddress: string | undefined)` returns meoized WakuPolling object

6
packages/vote-example/README.md
View File

@ -1,4 +1,6 @@
Package contains example usage of voting sdk # DappConnect Vote SDK Example
Package contains example usage of DappConnect Vote SDK
For more detailed api please see README in voting-hooks and voting-components For more detailed api please see README in voting-hooks and voting-components
@ -43,4 +45,4 @@ const votes = useVotingRoomsId(wakuVoting)
To create voting room you can use `NewVotingRoomModal` component. To create voting room you can use `NewVotingRoomModal` component.
Component is a modal and expects a state value and state update function (`showModal` and `setShowModal`) to be able show and hide modal Component is a modal and expects a state value and state update function (`showModal` and `setShowModal`) to be able show and hide modal