Update readMe docs #905
Update readMe docs #905
Conversation
…g started with solana-wallet-adapter
There was a problem hiding this comment.
Hey, thanks for opening this PR! In general I think it could be useful to add more content to this README to make it easier to find information
A few general points though:
-
Please stick to Markdown, not HTML. While Github renders the combination reasonably well, markdown is more widely used and should be sufficient for everything we need in a README. Github also has a pretty good range of markdown functionality.
-
We still need to keep all the existing links, this PR has some broken links and seems to remove some
-
Please don't add the SWA branding, we haven't used that before and it'll confuse developers who are familiar with wallet-adapter
README.md
Outdated
| <!--PROJECT SHIELDS --> | ||
| <center> | ||
|
|
||
| [![Contributors][contributors-shield]][contributors-url] | ||
| [![Forks][forks-shield]][forks-url] | ||
| [![Stargazers][stars-shield]][stars-url] | ||
| [![Issues][issues-shield]][issues-url] | ||
| [![MIT License][license-shield]][license-url] | ||
|
|
||
| </center> |
There was a problem hiding this comment.
Let's leave these out for now, none of our other readmes use these shields.io shields AFAIK
There was a problem hiding this comment.
Thanks for the review and all feedback is duly noted
README.md
Outdated
| @@ -1,14 +1,246 @@ | |||
| # Wallet Adapter | |||
| # <center>Solana Wallet Adapter </center> | |||
There was a problem hiding this comment.
As a general point, please just stick to markdown and don't rewrite this all in HTML. It does render OK on Github but markdown is simpler and more consistent.
README.md
Outdated
|
|
||
| <!--PROJECT DESCRIPTION --> | ||
| <div> | ||
| <p> The Solana Wallet Adapter (SWA) is a powerful toolkit designed to streamline the integration of Solana-based decentralized applications (dApps) with various wallet solutions. Developed and maintained by the Solana community, SWA offers a versatile set of modular TypeScript wallet adapters and components tailored specifically for Solana applications.</p> |
There was a problem hiding this comment.
We've never used this SWA branding before, please keep it to wallet-adapter
README.md
Outdated
| <p>At its core, SWA simplifies the process of connecting dApps with users' preferred wallets, offering seamless integration with over a dozen Solana wallets right out of the box. By leveraging SWA, developers can eliminate the complexities associated with individually supporting each wallet, thus enhancing accessibility and user experience. </p> | ||
|
|
||
| ####Key features and benefits of SWA include: | ||
| - Open Source and Solana Labs Support: SWA is an open-source project actively supported by Solana Labs, ensuring continuous improvement and community-driven development. |
There was a problem hiding this comment.
Now supported by Anza :)
README.md
Outdated
| - Customizable UI: SWA provides an off-the-shelf customizable user interface, enabling developers to tailor the wallet integration experience to align with the aesthetic and functional requirements of their dApps. | ||
| - Anchor Integration: SWA seamlessly integrates with Anchor, a comprehensive development framework for building Solana dApps, offering enhanced functionality and compatibility. | ||
| - Key Functionality: SWA offers essential functionalities such as Connect, Disconnect, and Auto-connect, streamlining the interaction between dApps and users' wallets. | ||
| - Support for Multiple Environment and Front-End Frameworks: SWA is designed to work seamlessly with various front-end frameworks and environment such as mobile and gaming development (unit), offering flexibility and compatibility across different development environments. |
There was a problem hiding this comment.
Yes that was a typo I meant Unity
README.md
Outdated
| <p> The Solana Wallet Adapter (SWA) is a powerful toolkit designed to streamline the integration of Solana-based decentralized applications (dApps) with various wallet solutions. Developed and maintained by the Solana community, SWA offers a versatile set of modular TypeScript wallet adapters and components tailored specifically for Solana applications.</p> | ||
| <p>At its core, SWA simplifies the process of connecting dApps with users' preferred wallets, offering seamless integration with over a dozen Solana wallets right out of the box. By leveraging SWA, developers can eliminate the complexities associated with individually supporting each wallet, thus enhancing accessibility and user experience. </p> | ||
|
|
||
| ####Key features and benefits of SWA include: |
There was a problem hiding this comment.
You need a space after the # to make these headers work correctly
You can view this file rendered here to debug: https://github.com/anza-xyz/wallet-adapter/blob/fb2cb590de546072c40b2e519dbfaf2ef9c6d4ba/README.md
README.md
Outdated
| <p align="center"> | ||
| <a href="#"><strong>View demo</strong> </a> | ||
| · | ||
| <a href="#"><strong>Report bug</strong> </a> | ||
| · | ||
| <a href="#/df"><strong>Request feature</strong> </a> | ||
| · | ||
| <a href="#/df"><strong>FAQ</strong> </a> | ||
| </p> |
There was a problem hiding this comment.
None of these links work
README.md
Outdated
| ###Table of Contents | ||
| <ul> | ||
| <li> | ||
| Installation & Setup | ||
| <ul> | ||
| <li> | ||
| <a href="#ReactJS"> ReactJS </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/lorisleiva/solana-wallets-vue"> VueJS </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/svelte-on-solana/wallet-adapter"> Svelte </a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/magicblock-labs/Solana.Unity-SDK"> Unit-SDK </a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="https://github.com/anza-xyz/wallet-adapter/blob/master/FAQ.md">FAQ</a></li> | ||
| <li><a href="https://github.com/anza-xyz/wallet-adapter/blob/master/PACKAGES.md">Packages</a></li> | ||
| <li><a href="https://github.com/anza-xyz/wallet-adapter/blob/master/BUILD.md">Build from source</a></li> | ||
| <li><a href="#Resource">Resource</a></li> | ||
|
|
||
| </ul> |
There was a problem hiding this comment.
I don't think we should add a table of contents. Github does this for us if we use Markdown headings
README.md
Outdated
| ``` | ||
|
|
||
| * Setup | ||
| ```sh |
There was a problem hiding this comment.
| ```sh | |
| ```tsx |
README.md
Outdated
| ``` | ||
|
|
||
| * Usage | ||
| ```sh |
There was a problem hiding this comment.
| ```sh | |
| ```tsx |
Updated readMe file with a more organized documentation to get started with solana-wallet-adapter