From a1524329769b4f38f8df3a6ed81b0de17066ec36 Mon Sep 17 00:00:00 2001 From: Franck Date: Tue, 7 Dec 2021 13:24:10 +1100 Subject: [PATCH] Fix some typos, add title to readmes --- packages/example/README.md | 5 +---- packages/poll-example/README.md | 4 +++- packages/poll-react-hooks/README.md | 4 ++-- packages/vote-example/README.md | 6 ++++-- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/packages/example/README.md b/packages/example/README.md index c2d1749..c40a246 100644 --- a/packages/example/README.md +++ b/packages/example/README.md @@ -1,4 +1 @@ -# status-community-dapp -Community directory curator dApp for Status - -Webpack for hosting polling and proposal apps \ No newline at end of file +# DappConnect Vote & Poll SDK Example diff --git a/packages/poll-example/README.md b/packages/poll-example/README.md index 998ef4e..c5b4ee9 100644 --- a/packages/poll-example/README.md +++ b/packages/poll-example/README.md @@ -1,3 +1,5 @@ +# DappConnect Poll SDK Example + This package is example usage of WakuPolling Example uses usedapp for exposing web3 provider @@ -67,4 +69,4 @@ Waku polling also exposes `getDetailedTimedPolls` ``` const DetailedTimedPolls = await wakuPolling.getDetailedTimedPolls() -``` \ No newline at end of file +``` diff --git a/packages/poll-react-hooks/README.md b/packages/poll-react-hooks/README.md index ee77720..3a7a120 100644 --- a/packages/poll-react-hooks/README.md +++ b/packages/poll-react-hooks/README.md @@ -1,7 +1,7 @@ -Package contains react hooks that help with memoizing values +Package contains react hooks that help with memorizing values ## hooks -`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 \ No newline at end of file +-`useWakuPolling(appName: string, tokenAddress: string, provider: Web3Provider | undefined, multicallAddress: string | undefined)` returns meoized WakuPolling object diff --git a/packages/vote-example/README.md b/packages/vote-example/README.md index bd6d239..218ed06 100644 --- a/packages/vote-example/README.md +++ b/packages/vote-example/README.md @@ -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 @@ -43,4 +45,4 @@ const votes = useVotingRoomsId(wakuVoting) 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 \ No newline at end of file +Component is a modal and expects a state value and state update function (`showModal` and `setShowModal`) to be able show and hide modal