Skip to content
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.

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

docs: react native sdk readme fix #1263

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

kalashshah
Copy link
Contributor

Fixes Issue

Update React Native SDK, installation guide

Check List (Check all the applicable boxes)

  • My code follows the code style of this project.
  • My change requires changes to the documentation.
  • I have updated the documentation accordingly.
  • This PR does not contain plagiarized content.
  • The title of my pull request is a short description of the requested changes.

Screenshots

Note to reviewers

React Native SDK, installation guide fix

Copy link

github-actions bot commented May 3, 2024

In the provided code:

  1. There is an extra closing </h1> tag after the <h4> tag, which should be removed.
  2. The <div> tag is not opened properly and seems unnecessary. It should be removed.
  3. It looks like there is a typo in the text Build PUSH features into their DApps, where PUSH should be replaced with Push.
  4. In the postinstall script in the package.json file, the values of crypto,assert,url,stream,events,http,https,os,url,net,fs should not repeat url, and assert is not required in that list.
  5. In the import statement for WebViewCrypto in the app root, the module path should be '@pushprotocol/react-native-sdk' instead of 'react-native-webview-crypto'.
  6. The link to the restapi documentation seems incorrect. It should point to the correct location. The current link is https://github.com/push-protocol/push-sdk/blob/main/packages/restapi/README.md#sdk-features.
  7. The Discord link in the contributing section seems broken. It should be corrected.
  8. In the License section, the link should be corrected to the license file location.

After addressing these issues, the code seems structured and formatted correctly.

All looks good.

Copy link

github-actions bot commented May 6, 2024

In the HTML code provided, I can see a few issues:

  1. The second closing </h1> tag after the social media icons should be corrected (</div> should be used instead of </h1>).
  2. There is a random </h1> tag after the block of social media icons which should be removed as it is unnecessary.

Other than that, the content seems to be structured correctly and there are no major issues.

Overall, the changes needed are minor, and the code is well-structured.

Here are the corrected sections:

<h1 align="center">
    <a href="https://push.org/#gh-light-mode-only">
    <img width='20%' height='10%' 
src="https://res.cloudinary.com/drdjegqln/image/upload/v1686227557/Push-Logo-Standard-Dark_xap7z5.png">
    </a>
    <a href="https://push.org/#gh-dark-mode-only">
    <img width='20%' height='10%' 
src="https://res.cloudinary.com/drdjegqln/image/upload/v1686227558/Push-Logo-Standard-White_dlvapc.png">
    </a>
</h1>

<p align="center">
  <i align="center">Push Protocol is a web3 communication network, enabling cross-chain notifications, messaging, video, and NFT chat for dapps, wallets, and services.🚀</i>
</p>

<h4 align="center">

  <a href="https://discord.com/invite/pushprotocol">
    <img src="https://img.shields.io/badge/discord-7289da.svg?style=flat-square" alt="discord">
  </a>
  <a href="https://twitter.com/pushprotocol">
    <img src="https://img.shields.io/badge/twitter-18a1d6.svg?style=flat-square" alt="twitter">
  </a>
  <a href="https://www.youtube.com/@pushprotocol">
    <img src="https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&" alt="youtube">
  </a>
</h4>
</div>

All looks good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant