Skip to content

Commit 6ae9c51

Browse files
updated readme
1 parent 40370e6 commit 6ae9c51

File tree

2 files changed

+61
-2
lines changed

2 files changed

+61
-2
lines changed

packages/core/README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,35 @@
33
[![npm version](https://img.shields.io/npm/v/@web3auth/core?label=%22%22)](https://www.npmjs.com/package/@web3auth/core/v/latest)
44
[![minzip](https://img.shields.io/bundlephobia/minzip/@web3auth/core?label=%22%22)](https://bundlephobia.com/result?p=@web3auth/core@latest)
55

6-
Provides the core logic for handling adapters within web3auth.
6+
Web3Auth is pluggable auth infrastructure for Web3 wallets and applications. It streamlines the onboarding of both mainstream and crypto native users under a minute by providing experiences that they're most comfortable with.
7+
8+
With support for all social logins, web & mobile native platforms, wallets and other key management methods, **Web3Auth results in a standard cryptographic key provider specific to the user and application.**
9+
10+
This package provides the core logic for handling adapters within web3auth.
711
This package acts as a manager for all the adapters.
812
You should use this package to build your custom login UI on top of web3auth.
13+
14+
### Checkout the official [Web3Auth Documentation](https://docs.web3auth.io) and [API Reference](https://docs.web3auth.io/api-reference) to get started!
15+
16+
### Custom Login UI SDK
17+
18+
### [`@web3auth/core`](https://npmjs.com/package/@web3auth/core)
19+
20+
This package provides the core logic for handling adapters within web3auth. This package acts as a manager for all the adapters. You should use this
21+
package to build your custom login UI on top of web3auth.
22+
23+
### Installation
24+
25+
#### npm
26+
27+
```shell
28+
npm i --save @web3auth/core
29+
```
30+
31+
#### yarn
32+
33+
```shell
34+
yarn add @web3auth/core
35+
```
36+
37+
#### Head on to the [Custom Login UI API Reference](https://docs.web3auth.io/api-reference/web/customloginui) to get started.

packages/modal/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,35 @@
33
[![npm version](https://img.shields.io/npm/v/@web3auth/web3auth?label=%22%22)](https://www.npmjs.com/package/@web3auth/web3auth/v/latest)
44
[![minzip](https://img.shields.io/bundlephobia/minzip/@web3auth/web3auth?label=%22%22)](https://bundlephobia.com/result?p=@web3auth/web3auth@latest)
55

6-
Provides the main class for using default web3auth modal. It inherits `@web3auth/core` package. So you can still call all the functions available in the `@web3auth/core` api reference.
6+
Web3Auth is pluggable auth infrastructure for Web3 wallets and applications. It streamlines the onboarding of both mainstream and crypto native users under a minute by providing experiences that they're most comfortable with.
7+
8+
With support for all social logins, web & mobile native platforms, wallets and other key management methods, **Web3Auth results in a standard cryptographic key provider specific to the user and application.**
9+
10+
This package provides the main class for using default web3auth modal. It inherits `@web3auth/core` package. So you can still call all the functions available in the `@web3auth/core` api reference.
711
The package includes all of our packages and gives you a simple way of implementing Web3Auth within your interface.
12+
13+
### Checkout the official [Web3Auth Documentation](https://docs.web3auth.io) and [API Reference](https://docs.web3auth.io/api-reference) to get started!
14+
15+
### Plug n Play SDK
16+
17+
### [`@web3auth/web3auth`](https://npmjs.com/package/@web3auth/web3auth)
18+
19+
This package provides main class for using default web3auth modal. It inherits `@web3auth/core` package. So you can still call all the
20+
functions available in the `@web3auth/core` api reference. The package includes all of our packages and gives you a simple way of implementing
21+
Web3Auth within your interface.
22+
23+
### Installation
24+
25+
#### npm
26+
27+
```shell
28+
npm i --save @web3auth/web3auth
29+
```
30+
31+
#### yarn
32+
33+
```shell
34+
yarn add @web3auth/web3auth
35+
```
36+
37+
#### Head on to the [Plug n Play API Reference](https://docs.web3auth.io/api-reference/web/plugnplay) to get started.

0 commit comments

Comments
 (0)