Skip to content

Commit 1467b6e

Browse files
committed
fix readmes
1 parent b02fdfc commit 1467b6e

File tree

19 files changed

+170
-112
lines changed

19 files changed

+170
-112
lines changed

tkey-android/tkey-android-auth0-example/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-android)
44
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
55

6-
76
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
87

98
This example demonstrates how to use Web3Auth's tKey in Android.
@@ -13,7 +12,7 @@ This example demonstrates how to use Web3Auth's tKey in Android.
1312
### Download Manually
1413

1514
```bash
16-
npx degit Web3Auth/web3auth-core-kit-examples/tkey-android/tkey-android-auth0-example w3a-tkey-android-auth0
15+
npx degit tkey/tkey-examples/tkey-android/tkey-android-auth0-example w3a-tkey-android-auth0
1716
```
1817

1918
Install & Run:
@@ -30,4 +29,4 @@ cd w3a-tkey-android-auth0
3029
- [Guides](https://web3auth.io/docs/content-hub?type=guides)
3130
- [SDK / API References](https://web3auth.io/docs/sdk)
3231
- [Pricing](https://web3auth.io/pricing.html)
33-
- [Community Portal](https://community.web3auth.io)
32+
- [Community Portal](https://community.web3auth.io)

tkey-android/tkey-android-quick-start/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-android)
44
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
55

6-
76
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
87

98
This example demonstrates how to use Web3Auth's tKey in Android.
@@ -13,13 +12,13 @@ This example demonstrates how to use Web3Auth's tKey in Android.
1312
### Download Manually
1413

1514
```bash
16-
npx degit Web3Auth/web3auth-core-kit-examples/tkey-android/tkey-android-google-example w3a-tkey-android-google
15+
npx degit tkey/tkey-examples/tkey-android/tkey-android-quick-start w3a-tkey-android-quick-start
1716
```
1817

1918
Install & Run:
2019

2120
```bash
22-
cd w3a-tkey-android-google
21+
cd w3a-tkey-android-quick-start
2322
# run project in Xcode
2423
```
2524

@@ -30,4 +29,4 @@ cd w3a-tkey-android-google
3029
- [Guides](https://web3auth.io/docs/content-hub?type=guides)
3130
- [SDK / API References](https://web3auth.io/docs/sdk)
3231
- [Pricing](https://web3auth.io/pricing.html)
33-
- [Community Portal](https://community.web3auth.io)
32+
- [Community Portal](https://community.web3auth.io)
Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
# Web3Auth tKey Android Example with Google verifier
1+
# Web3Auth tKey Android Example with SFA
22

33
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-android)
44
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
55

6-
76
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
87

98
This example demonstrates how to use Web3Auth's tKey in Android with SFA.
@@ -13,13 +12,13 @@ This example demonstrates how to use Web3Auth's tKey in Android with SFA.
1312
### Download Manually
1413

1514
```bash
16-
npx degit Web3Auth/web3auth-core-kit-examples/tkey-android/tkey-android-sfa-quick-start w3a-tkey-android-sfa
15+
npx degit tkey/tkey-examples/tkey-android/tkey-android-sfa-quick-start w3a-tkey-android-sfa
1716
```
1817

1918
Install & Run:
2019

2120
```bash
22-
w3a-tkey-android-sfa
21+
cd w3a-tkey-android-sfa
2322
# run project in Android Studio
2423
```
2524

@@ -30,4 +29,4 @@ w3a-tkey-android-sfa
3029
- [Guides](https://web3auth.io/docs/content-hub?type=guides)
3130
- [SDK / API References](https://web3auth.io/docs/sdk)
3231
- [Pricing](https://web3auth.io/pricing.html)
33-
- [Community Portal](https://community.web3auth.io)
32+
- [Community Portal](https://community.web3auth.io)

tkey-ios/tkey-ios-aggregate-verifier-example/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-ios)
44
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
55

6-
76
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
87

98
This example demonstrates how to use Web3Auth's tKey in iOS.
@@ -13,7 +12,7 @@ This example demonstrates how to use Web3Auth's tKey in iOS.
1312
### Download Manually
1413

1514
```bash
16-
npx degit Web3Auth/web3auth-core-kit-examples/tkey-ios/tkey-ios-aggregate-example w3a-tkey-ios-aggregate
15+
npx degit tkey/tkey-examples/tkey-ios/tkey-ios-aggregate-example w3a-tkey-ios-aggregate
1716
```
1817

1918
Install & Run:
@@ -32,7 +31,7 @@ cd w3a-tkey-ios-aggregate
3231
- [Pricing](https://web3auth.io/pricing.html)
3332
- [Community Portal](https://community.web3auth.io)
3433

35-
# Tkey ios example application document
34+
# Tkey ios example application document
3635

3736
This repository is an example application created by implementing the [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios) and [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
3837
With this example app, you can test the various functions of the tkey SDK, and also google Social Login.
@@ -45,10 +44,12 @@ Once you're logged in, you can run a number of tkey-related functions.
4544
Buttons allow you to test various modules and tkey built-in functions.
4645

4746
## dependency
48-
- [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios)
47+
48+
- [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios)
4949
- [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
5050

5151
## Main Page
52+
5253
![mainPage](https://github.com/Web3Auth/web3auth-locales/assets/6962565/d3eb7adb-e6d7-4fc3-b36b-2772ccb20e1a)
5354

5455
### how to start
@@ -60,17 +61,17 @@ This means that both shares will be required for login. (2/2 setting)
6061
On the other hand, if you log in with an existing account, you would need to have the saved shares for the reconstruction to succeed.
6162

6263
### testing on multiple device
64+
6365
If you want to test logging in with the same google account on different devices, you need to set up additional settings.
6466
Create an additional security question share by pressing the `Add password` button in the security question module.
6567

66-
After that, try initialize on the second device. If you try it right away, you won't have the necessary shares and fail reconstruction.
68+
After that, try initialize on the second device. If you try it right away, you won't have the necessary shares and fail reconstruction.
6769
This is because the threshold required for reconstruct is 2, but the new device only has one existing social login share.
6870

6971
At this point, run `Enter SecurityQuestion password` button to retrieve the security question share which was set on the old device and save it locally to the new device.
7072
After that, when logging in from that device, you can initialize it directly without entering the security question password.
7173

72-
7374
### Reset Account (Critical)
7475

7576
If you are unable to recover your account, such as losing your recovery key, you can reset your account.
76-
However, you will lose your existing private key, so please use this feature with extreme caution.
77+
However, you will lose your existing private key, so please use this feature with extreme caution.

tkey-ios/tkey-ios-auth0-example/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-ios)
44
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
55

6-
76
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
87

98
This example demonstrates how to use Web3Auth's tKey in iOS.
@@ -13,7 +12,7 @@ This example demonstrates how to use Web3Auth's tKey in iOS.
1312
### Download Manually
1413

1514
```bash
16-
npx degit Web3Auth/web3auth-core-kit-examples/tkey-ios/tkey-ios-auth0-example w3a-tkey-ios-auth0
15+
npx degit tkey/tkey-examples/tkey-ios/tkey-ios-auth0-example w3a-tkey-ios-auth0
1716
```
1817

1918
Install & Run:
@@ -32,7 +31,7 @@ cd w3a-tkey-ios-auth0
3231
- [Pricing](https://web3auth.io/pricing.html)
3332
- [Community Portal](https://community.web3auth.io)
3433

35-
# Tkey ios example application document
34+
# Tkey ios example application document
3635

3736
This repository is an example application created by implementing the [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios) and [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
3837
With this example app, you can test the various functions of the tkey SDK, and also google Social Login.
@@ -45,10 +44,12 @@ Once you're logged in, you can run a number of tkey-related functions.
4544
Buttons allow you to test various modules and tkey built-in functions.
4645

4746
## dependency
48-
- [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios)
47+
48+
- [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios)
4949
- [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
5050

5151
## Main Page
52+
5253
![mainPage](https://github.com/Web3Auth/web3auth-locales/assets/6962565/d3eb7adb-e6d7-4fc3-b36b-2772ccb20e1a)
5354

5455
### how to start
@@ -60,17 +61,17 @@ This means that both shares will be required for login. (2/2 setting)
6061
On the other hand, if you log in with an existing account, you would need to have the saved shares for the reconstruction to succeed.
6162

6263
### testing on multiple device
64+
6365
If you want to test logging in with the same google account on different devices, you need to set up additional settings.
6466
Create an additional security question share by pressing the `Add password` button in the security question module.
6567

66-
After that, try initialize on the second device. If you try it right away, you won't have the necessary shares and fail reconstruction.
68+
After that, try initialize on the second device. If you try it right away, you won't have the necessary shares and fail reconstruction.
6769
This is because the threshold required for reconstruct is 2, but the new device only has one existing social login share.
6870

6971
At this point, run `Enter SecurityQuestion password` button to retrieve the security question share which was set on the old device and save it locally to the new device.
7072
After that, when logging in from that device, you can initialize it directly without entering the security question password.
7173

72-
7374
### Reset Account (Critical)
7475

7576
If you are unable to recover your account, such as losing your recovery key, you can reset your account.
76-
However, you will lose your existing private key, so please use this feature with extreme caution.
77+
However, you will lose your existing private key, so please use this feature with extreme caution.

tkey-ios/tkey-ios-firebase-example/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-ios)
44
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
55

6-
76
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
87

98
This example demonstrates how to use Web3Auth's tKey in iOS.
@@ -13,7 +12,7 @@ This example demonstrates how to use Web3Auth's tKey in iOS.
1312
### Download Manually
1413

1514
```bash
16-
npx degit Web3Auth/web3auth-core-kit-examples/tkey-ios/tkey-ios-firebase-example w3a-tkey-ios-firebase
15+
npx degit tkey/tkey-examples/tkey-ios/tkey-ios-firebase-example w3a-tkey-ios-firebase
1716
```
1817

1918
Install & Run:
@@ -32,7 +31,7 @@ cd w3a-tkey-ios-firebase
3231
- [Pricing](https://web3auth.io/pricing.html)
3332
- [Community Portal](https://community.web3auth.io)
3433

35-
# Tkey ios example application document
34+
# Tkey ios example application document
3635

3736
This repository is an example application created by implementing the [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios) and [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
3837
With this example app, you can test the various functions of the tkey SDK, and also google Social Login.
@@ -45,10 +44,12 @@ Once you're logged in, you can run a number of tkey-related functions.
4544
Buttons allow you to test various modules and tkey built-in functions.
4645

4746
## dependency
48-
- [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios)
47+
48+
- [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios)
4949
- [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
5050

5151
## Main Page
52+
5253
![mainPage](https://github.com/Web3Auth/web3auth-locales/assets/6962565/d3eb7adb-e6d7-4fc3-b36b-2772ccb20e1a)
5354

5455
### how to start
@@ -60,17 +61,17 @@ This means that both shares will be required for login. (2/2 setting)
6061
On the other hand, if you log in with an existing account, you would need to have the saved shares for the reconstruction to succeed.
6162

6263
### testing on multiple device
64+
6365
If you want to test logging in with the same google account on different devices, you need to set up additional settings.
6466
Create an additional security question share by pressing the `Add password` button in the security question module.
6567

66-
After that, try initialize on the second device. If you try it right away, you won't have the necessary shares and fail reconstruction.
68+
After that, try initialize on the second device. If you try it right away, you won't have the necessary shares and fail reconstruction.
6769
This is because the threshold required for reconstruct is 2, but the new device only has one existing social login share.
6870

6971
At this point, run `Enter SecurityQuestion password` button to retrieve the security question share which was set on the old device and save it locally to the new device.
7072
After that, when logging in from that device, you can initialize it directly without entering the security question password.
7173

72-
7374
### Reset Account (Critical)
7475

7576
If you are unable to recover your account, such as losing your recovery key, you can reset your account.
76-
However, you will lose your existing private key, so please use this feature with extreme caution.
77+
However, you will lose your existing private key, so please use this feature with extreme caution.
Lines changed: 3 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
# Web3Auth tKey iOS Example with Google verifier
1+
# Web3Auth tKey iOS QuickStart
22

33
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-ios)
44
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
55

6-
76
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
87

98
This example demonstrates how to use Web3Auth's tKey in iOS.
@@ -13,13 +12,13 @@ This example demonstrates how to use Web3Auth's tKey in iOS.
1312
### Download Manually
1413

1514
```bash
16-
npx degit Web3Auth/web3auth-core-kit-examples/tkey-ios/tkey-ios-google-example w3a-tkey-ios-google
15+
npx degit tkey/tkey-examples/tkey-ios/tkey-ios-quick-start w3a-tkey-ios-quick-start
1716
```
1817

1918
Install & Run:
2019

2120
```bash
22-
cd w3a-tkey-ios-google
21+
cd w3a-tkey-ios-quick-start
2322
# run project in Xcode
2423
```
2524

@@ -31,46 +30,3 @@ cd w3a-tkey-ios-google
3130
- [SDK / API References](https://web3auth.io/docs/sdk)
3231
- [Pricing](https://web3auth.io/pricing.html)
3332
- [Community Portal](https://community.web3auth.io)
34-
35-
# Tkey ios example application document
36-
37-
This repository is an example application created by implementing the [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios) and [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
38-
With this example app, you can test the various functions of the tkey SDK, and also google Social Login.
39-
40-
After complete building, you can login via your google account.
41-
If you don't have tKey, you can make your own tkey account by clicking this button, using customAuth sdk.
42-
If you already have your account, existing account can be used as well.
43-
44-
Once you're logged in, you can run a number of tkey-related functions.
45-
Buttons allow you to test various modules and tkey built-in functions.
46-
47-
## dependency
48-
- [tkey ios SDK](https://github.com/torusresearch/tkey-rust-ios)
49-
- [customAuth swift SDK](https://github.com/torusresearch/customauth-swift-sdk).
50-
51-
## Main Page
52-
![mainPage](https://github.com/Web3Auth/web3auth-locales/assets/6962565/d3eb7adb-e6d7-4fc3-b36b-2772ccb20e1a)
53-
54-
### how to start
55-
56-
Once you have the final tkey from initialize and reconstruct tkey, you can test all the features.
57-
The first time you run `Initialize and reconstruct tkey`, two shares will be created and the threshold will be set to two.
58-
This means that both shares will be required for login. (2/2 setting)
59-
60-
On the other hand, if you log in with an existing account, you would need to have the saved shares for the reconstruction to succeed.
61-
62-
### testing on multiple device
63-
If you want to test logging in with the same google account on different devices, you need to set up additional settings.
64-
Create an additional security question share by pressing the `Add password` button in the security question module.
65-
66-
After that, try initialize on the second device. If you try it right away, you won't have the necessary shares and fail reconstruction.
67-
This is because the threshold required for reconstruct is 2, but the new device only has one existing social login share.
68-
69-
At this point, run `Enter SecurityQuestion password` button to retrieve the security question share which was set on the old device and save it locally to the new device.
70-
After that, when logging in from that device, you can initialize it directly without entering the security question password.
71-
72-
73-
### Reset Account (Critical)
74-
75-
If you are unable to recover your account, such as losing your recovery key, you can reset your account.
76-
However, you will lose your existing private key, so please use this feature with extreme caution.

tkey-mpc-ios/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Web3Auth tKey MPC iOS Example
2+
3+
[![Web3Auth](https://img.shields.io/badge/Web3Auth-SDK-blue)](https://web3auth.io/docs/sdk/core-kit/tkey-ios)
4+
[![Web3Auth](https://img.shields.io/badge/Web3Auth-Community-cyan)](https://community.web3auth.io)
5+
6+
[Join our Community Portal](https://community.web3auth.io/) to get support and stay up to date with the latest news and updates.
7+
8+
This example demonstrates how to use Web3Auth's tKey in iOS.
9+
10+
## How to Use
11+
12+
### Download Manually
13+
14+
```bash
15+
npx degit tkey/tkey-examples/tkey-mpc-ios w3a-tkey-mpc-ios
16+
```
17+
18+
Install & Run:
19+
20+
```bash
21+
cd w3a-tkey-mpc-ios
22+
# run project in Xcode
23+
```
24+
25+
## Important Links
26+
27+
- [Website](https://web3auth.io)
28+
- [Docs](https://web3auth.io/docs)
29+
- [Guides](https://web3auth.io/docs/content-hub?type=guides)
30+
- [SDK / API References](https://web3auth.io/docs/sdk)
31+
- [Pricing](https://web3auth.io/pricing.html)
32+
- [Community Portal](https://community.web3auth.io)

tkey-mpc-web/tkey-mpc-react-bitcoin-example/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This example demonstrates how to use Web3Auth's tKey MPC Beta in a React environ
1212
### Download Manually
1313

1414
```bash
15-
npx degit Web3Auth/web3auth-core-kit-examples/mpc-core-kit/tkey-mpc-react-bitcoin-example w3a-tkey-mpc-bitcoin-example
15+
npx degit tkey/tkey-examples/tkey-mpc-web/tkey-mpc-react-bitcoin-example w3a-tkey-mpc-bitcoin-example
1616
```
1717

1818
Install & Run:
@@ -34,4 +34,4 @@ yarn start
3434
- [Guides](https://web3auth.io/docs/content-hub?type=guides)
3535
- [SDK / API References](https://web3auth.io/docs/sdk)
3636
- [Pricing](https://web3auth.io/pricing.html)
37-
- [Community Portal](https://community.web3auth.io)
37+
- [Community Portal](https://community.web3auth.io)

0 commit comments

Comments
 (0)