Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dawidsowardx committed Nov 14, 2024
1 parent eff36ed commit 182700e
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 56 deletions.
106 changes: 97 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,46 @@
# <img src="docs/radix-logo.png" alt="Radix Logo" width="35" height="35"> Radix dApp Toolkit: Tools for building dApps on Radix
<div align="center">
<img src="docs/radix-logo.png" alt="Radix Logo" width="100">

[![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
<em> RDT is a TypeScript library which simplifies interactions between your dApp and Radix Wallet. It comes together with a custom HTML element which provides unified interface to display user information.</em>

Look for dApp toolkit and related packages under the [/packages](/packages/) directory. Example applications are under the [/examples](/examples/) directory.
<a href="https://radixdlt.com/"><strong>radixdlt.com</strong></a>

</div>
<p align="center">
<a href="CONTRIBUTION.md">Contributing Guidelines</a>
·
<a href="https://github.com/radixdlt/radix-dapp-toolkit/issues">Submit an Issue</a>
·
<a href="https://docs.radixdlt.com/docs">Radix Docs</a>

</p>

[Apache 2.0 License](LICENSE)
<p align="center">
<a href="LICENSE">
<img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="license" />
</a>
<a href="RADIX-SOFTWARE-EULA">
<img src="https://img.shields.io/badge/EULA-red" alt="eula" />
</a>
<br/>
<a href="https://www.npmjs.com/@radixdlt/radix-dapp-toolkit">
<img src="https://img.shields.io/npm/v/@radixdlt/radix-dapp-toolkit.svg?logo=npm&logoColor=fff&label=NPM+package&color=limegreen" alt="RDT on NPM" />
</a>
<a href="http://discord.gg/radixdlt">
<img src="https://img.shields.io/discord/417762285172555786.svg?logo=discord&logoColor=fff&label=Discord&color=7389d8" alt="Discord conversation" />
</a>
<a href="https://www.npmjs.com/@radixdlt/radix-dapp-toolkit">
<img src="https://img.shields.io/npm/dm/@radixdlt/radix-dapp-toolkit" alt="Discord conversation" />
</a>
</p>

- [Code of Conduct](CODE_OF_CONDUCT.md)
- [Contribution Guidelines](CONTRIBUTION.md)
- [EULA](RADIX-SOFTWARE-EULA)
<hr>

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.
## Structure

Look for dApp toolkit and related packages under the [/packages](/packages/) directory. Example applications are under the [/examples](/examples/) directory.

## Migration guide

Expand All @@ -34,3 +62,63 @@ 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][changelog].

## Upgrading

Check out our [upgrade guide](https://angular.dev/update-guide/) to find out the best way to upgrade your project.

## Contributing

### Contributing Guidelines

Read through our [contributing guidelines][contributing] 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][contributing] and then check out one of our issues labeled as <kbd>[help wanted](https://github.com/angular/angular/labels/help%20wanted)</kbd> or <kbd>[good first issue](https://github.com/angular/angular/labels/good%20first%20issue)</kbd>.

### Code of Conduct

Help us keep Radix dApp Toolkit open and inclusive. Please read and follow our [Code of Conduct][codeofconduct].

## Community

Join the conversation and help the community.

- [X (formerly Twitter)][X (formerly Twitter)]
- [Discord][discord]
- [Gitter][gitter]
- [YouTube][youtube]
- [StackOverflow][stackoverflow]

**Love Radix dApp Toolkit? Give our repo a star :star: :arrow_up:.**

[contributing]: CONTRIBUTING.md
[quickstart]: https://angular.dev/tutorials/learn-angular
[changelog]: CHANGELOG.md
[ng]: https://angular.dev
[documentation]: https://angular.dev/overview
[angularmaterial]: https://material.angular.io/
[cli]: https://angular.dev/tools/cli
[architecture]: https://angular.dev/essentials
[componentstemplates]: https://angular.dev/tutorials/learn-angular/1-components-in-angular
[forms]: https://angular.dev/tutorials/learn-angular/15-forms
[api]: https://angular.dev/api
[angularelements]: https://angular.dev/guide/elements
[ssr]: https://angular.dev/guide/ssr
[schematics]: https://angular.dev/tools/cli/schematics
[lazyloading]: https://angular.dev/guide/ngmodules/lazy-loading
[node.js]: https://nodejs.org/
[npm]: https://www.npmjs.com/get-npm
[codeofconduct]: CODE_OF_CONDUCT.md
[X (formerly Twitter)]: https://www.twitter.com/angular
[discord]: https://discord.gg/angular
[gitter]: https://gitter.im/angular/angular
[stackoverflow]: https://stackoverflow.com/questions/tagged/angular
[youtube]: https://youtube.com/angular
[meetup]: https://www.meetup.com/find/?keywords=angular
[animations]: https://angular.dev/guide/animations
48 changes: 1 addition & 47 deletions packages/dapp-toolkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +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)
- [Using `create-radix-dapp`](#using-create-radix-dapp)
- [Usage](#usage)
- [Getting started](#getting-started)
- [Login requests](#login-requests)
- [User authentication](#user-authentication)
- [Handle user authentication](#handle-user-authentication)
- [Authenticate specific account or persona](#authenticate-specific-account-or-persona)
- [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)
- [`OneTimeDataRequestBuilderItem.proofOfOwnership()`](#onetimedatarequestbuilderitemproofofownership)
- [`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?

Expand Down Expand Up @@ -80,7 +34,7 @@ npm install @radixdlt/radix-dapp-toolkit
Add following code to head section of your page. See example usage inside `examples/cdn/index.html`

```html
<script src="https://www.unpkg.com/@radixdlt/radix-dapp-toolkit@2.1.0/dist/radix-dapp-toolkit.bundle.umd.cjs"></script>
<script src="https://cdn.jsdelivr.net/npm/@radixdlt/radix-dapp-toolkit@2.2.0-dev.10/dist/radix-dapp-toolkit.bundle.umd.js" integrity="sha256-JovDn3asdbgkH7NsCN9iebOTU6yxYCYUCO4Q2JffSF0=" crossorigin="anonymous"></script>
```

## Using `create-radix-dapp`
Expand Down

0 comments on commit 182700e

Please sign in to comment.