From 63919367457d451d36406ece4c16eb049f55bfa6 Mon Sep 17 00:00:00 2001 From: Dawid Sowa Date: Thu, 14 Nov 2024 10:36:55 +0100 Subject: [PATCH] docs: update README --- README.md | 96 +++++++++++++++++++++++++++------ packages/dapp-toolkit/README.md | 53 ++++-------------- 2 files changed, 89 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index cb4a3b17..53ff625a 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,60 @@ -# Radix Logo Radix dApp Toolkit: Tools for building dApps on Radix +
+ Radix Logo -[![npm version](https://badge.fury.io/js/@radixdlt%2Fradix-dapp-toolkit.svg)](https://badge.fury.io/js/@radixdlt%2Fradix-dapp-toolkit) + # Radix dApp Toolkit -# Radix dApp Toolkit - v2 Monorepo + RDT is a TypeScript library that simplifies interactions between your dApp and Radix Wallet. It comes together with a custom HTML element which provides unified interface to display user information. -Look for dApp toolkit and related packages under the [/packages](/packages/) directory. Example applications are under the [/examples](/examples/) directory. + radixdlt.com + +
+

+ Radix Docs + · + Contributing Guidelines + · + Submit an Issue +

-[Apache 2.0 License](LICENSE) +

+ + license + + + eula + +
+ + RDT on NPM + + + Discord conversation + + + Discord conversation + +

-- [Code of Conduct](CODE_OF_CONDUCT.md) -- [Contribution Guidelines](CONTRIBUTION.md) -- [EULA](RADIX-SOFTWARE-EULA) +
-This is merging [Radix dApp Toolkit](https://github.com/radixdlt/radix-dapp-toolkit), [√ Connect Button](https://github.com/radixdlt/connect-button), [Wallet Request SDK](https://github.com/radixdlt/wallet-sdk), [Radix Connect Schemas](https://github.com/radixdlt/radix-connect-schemas) into one mono-repository. +## How to start? -## Migration guide +Install [Node.js] which includes [Node Package Manager][npm]. Use `create-radix-dapp` package - paste following command into your terminal and it will walk you through all required steps! -- [v1 -> v2 migration guide](docs/v2.md) +```bash +npx create-radix-dapp@latest +``` -## Versions In This Repository +> [!IMPORTANT] +> **Make sure you go through [README inside RDT package](packages/dapp-toolkit/README.md) for more in-depth information** -- [main](https://github.com/radixdlt/radix-dapp-toolkit/commits/main) - This is all of the current work, which is against v2 of RDT right now +### Official Examples -Most PRs should be made to **main**. +Make sure you take a look at our [official examples repository](https://github.com/radixdlt/official-examples/tree/main/getting-started). It will provide you with examples of not only how to start with RDT but also how to **issue your first cryptocurrency**! -## Important +## Structure -By contributing or commenting on issues in this repository, whether you've read them or not, you're agreeing to the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). Much like traffic laws, ignorance doesn't grant you immunity. +Look for dApp toolkit and related packages under the [/packages](/packages/) directory. Example applications are under the [/examples](/examples/) directory. ## Development @@ -34,3 +62,39 @@ By contributing or commenting on issues in this repository, whether you've read 2. `npm install` to install all dependencies 3. `npm run test` will run the test suite 4. `npm run dev` will start the dApp toolkit development servers + +## Changelog + +Learn about the latest improvements by looking at [GitHub Releases](https://github.com/radixdlt/radix-dapp-toolkit/releases) page + +## Contributing + +### Contributing Guidelines + +Read through our [contributing guidelines](CONTRIBUTION.md) to learn about our submission process, coding rules, and more. + +### Want to Help? + +Want to report a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for [contributing](CONTRIBUTION.md) and start building together with the community! + +### Code of Conduct + +Help us keep Radix dApp Toolkit open and inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). + +## Community + +Join the conversation and help the community. + +- [X][X] +- [Discord][discord] +- [YouTube][youtube] +- [GitHub](https://github.com/radixdlt) +- [Blog](https://www.radixdlt.com/blog) + +**Love Radix dApp Toolkit? Give our repo a star :star: :arrow_up:.** + +[node.js]: https://nodejs.org/ +[npm]: https://www.npmjs.com/get-npm +[X]: https://x.com/RadixDLT +[discord]: http://discord.gg/radixdlt +[youtube]: https://www.youtube.com/c/radixdlt diff --git a/packages/dapp-toolkit/README.md b/packages/dapp-toolkit/README.md index 99b7ae4b..f24178e2 100644 --- a/packages/dapp-toolkit/README.md +++ b/packages/dapp-toolkit/README.md @@ -2,49 +2,6 @@ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE) -- [ Radix dApp toolkit](#-radix-dapp-toolkit) -- [What is Radix dApp Toolkit?](#what-is-radix-dapp-toolkit) - - [Resources](#resources) - - [Building a dApp frontend](#building-a-dapp-frontend) -- [Installation](#installation) - - [Using NPM](#using-npm) - - [Using CDN](#using-cdn) -- [Usage](#usage) - - [Getting started](#getting-started) - - [Login requests](#login-requests) - - [User authentication](#user-authentication) - - [Handle user authentication](#handle-user-authentication) - - [User authentication management](#user-authentication-management) - - [Wallet data requests](#wallet-data-requests) - - [Trigger wallet data request programmatically](#trigger-wallet-data-request-programmatically) - - [Change requested data](#change-requested-data) - - [Data request builder](#data-request-builder) - - [`DataRequestBuilder.persona()`](#datarequestbuilderpersona) - - [`DataRequestBuilder.accounts()`](#datarequestbuilderaccounts) - - [`OneTimeDataRequestBuilderItem.accounts()`](#onetimedatarequestbuilderitemaccounts) - - [`DataRequestBuilder.personaData()`](#datarequestbuilderpersonadata) - - [`OneTimeDataRequestBuilderItem.personaData()`](#onetimedatarequestbuilderitempersonadata) - - [`DataRequestBuilder.config(input: DataRequestState)`](#datarequestbuilderconfiginput-datarequeststate) - - [Handle connect responses](#handle-connect-responses) - - [One Time Data Request](#one-time-data-request) - - [Data Requests Sandbox](#data-requests-sandbox) - - [State changes](#state-changes) - - [Transaction requests](#transaction-requests) - - [Build transaction manifest](#build-transaction-manifest) - - [sendTransaction](#sendtransaction) -- [ROLA (Radix Off-Ledger Authentication)](#rola-radix-off-ledger-authentication) -- [√ Connect Button](#-connect-button) - - [Styling](#styling) - - [Themes](#themes) - - [Modes](#modes) - - [CSS variables](#css-variables) - - [Compact mode](#compact-mode) - - [Sandbox](#sandbox) -- [Setting up your dApp Definition](#setting-up-your-dapp-definition) - - [Setting up a dApp Definition on the Radix Dashboard](#setting-up-a-dapp-definition-on-the-radix-dashboard) -- [Data storage](#data-storage) -- [Examples](#examples) -- [License](#license) # What is Radix dApp Toolkit? @@ -77,7 +34,15 @@ npm install @radixdlt/radix-dapp-toolkit Add following code to head section of your page. See example usage inside `examples/cdn/index.html` ```html - + +``` + +## Using `create-radix-dapp` + +Use our [CLI tool](https://github.com/radixdlt/create-radix-dapp) to scaffold a new project. Just paste following command into your terminal and it will walk you through all required steps! + +```bash +npx create-radix-dapp@latest ``` # Usage