Skip to content

Commit

Permalink
update...
Browse files Browse the repository at this point in the history
  • Loading branch information
astinz committed Dec 12, 2024
1 parent 87c8fff commit 92fa6c3
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 10 deletions.
4 changes: 3 additions & 1 deletion docs/topics/deepbook.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# DeepBook

TBA
Deepbook is a decentralized central limit order book (CLOB) native to Sui.

In this chapter, we'll cover how to integrate it into our apps for market making.
3 changes: 1 addition & 2 deletions docs/topics/ext-technology.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Extended Technology

This topic covers every other Sui technology that is not part of the core technologies.
It is important to mention that the term "core" is used loosely.
This cover every other Sui technology that is not part of the core technologies.

2 changes: 1 addition & 1 deletion docs/topics/misc.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Misc

Everything else pertaining to Sui that's good to know
This topic encompasses all the essential, general-purpose knowledge about Sui that’s simply good to have.
8 changes: 4 additions & 4 deletions docs/topics/welcome.topic
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,22 @@
</description>

<spotlight>
<a href="getting-started.topic" type="start" summary="Learn how to setup your Sui development environment">
<a href="getting-started.topic" type="start" summary="Learn how to setup your Sui development environment.">
</a>
<a href="Transactions.md" type="network"
summary="Learn how to construction Sui Transactions using both the SDK and PTB Studio">
summary="Learn how to construct Sui Transactions using both SDKs and PTB Studio.">
</a>
</spotlight>

<misc>
<cards>
<title>Extended Technologies</title>
<a href="deepbook.md"
summary="Easily add Sui's global liquidity to your app">
summary="Learn how to integrate Sui's global liquidity into your app.">
DeepBook
</a>
<a href="zklogin.topic"
summary="Use web2 credentials with Sui in your app">
summary="Discover how to integrate Web2 authentication methods into your Sui projects.">
zkLogin
</a>
</cards>
Expand Down
22 changes: 20 additions & 2 deletions docs/topics/zklogin.topic
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,33 @@
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="zkLogin" id="zklogin" help-id="zkLogin">
<show-structure for="tab,chapter,procedure" depth="2"/>
<p>zkLogin is a Sui primitive the enables us to use Web2 credentials on Sui.</p>
<p>This technology allows use to sign Sui Transactions using Web2 credentials from providers like Google, Facebook,
and Slack
</p>
Follow the steps below to integrate zkLogin into your app:


<tabs>
<tab id="android-install" title="Android">
Let's begin by adding dependency to the <b>ZeroAuth</b> Android zkLogin SDK. To do that,
add the following to your projects' app module dependency block:
<code-block lang="kotlin">
implementation("xyz.mcxross.bcs:bcs-android:&lt;$bcs_version&gt;")
implementation("xyz.mcxross.zero:auth-android:&lt;$zklogin_version&gt;")
</code-block>
<p>After installation, you can then use it as follows:</p>
<code-block lang="kotlin" src="zkLogin-android.kt" include-lines="1-15"/>
<p>You can the trigger the login process as follows:</p>
<p>The code above is how we'll retrieve our Sign In results.</p>
<p>In order to receive the results, we must trigger the login process as follows:</p>
<code-block lang="kotlin" src="zkLogin-android.kt" include-lines="18-27"/>
</tab>
<tab id="ios-install" title="iOS">
To be added
</tab>
</tabs>

The code above shows how to do zkLogin using Google as the Provider, however, the follow
is generally the same for all other supported providers.

For detailed information on <b>ZeroAuth</b>, go <a href="https://zeroauth.com">here</a>
</topic>

0 comments on commit 92fa6c3

Please sign in to comment.