Skip to content

Commit

Permalink
feat: update readme of packages with new documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
yum0e committed May 12, 2023
1 parent 4f48cc1 commit 08cd13d
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 19 deletions.
40 changes: 35 additions & 5 deletions packages/sismo-connect-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="https://static.sismo.io/readme/top-main.png" alt="Logo" width="150" height="150" style="borderRadius: 20px">

<h3 align="center">
sismoConnect Client
Sismo Connect Client
</h3>

<p align="center">
Expand All @@ -23,13 +23,43 @@
</p>
</div>

sismoConnect is a privacy-preserving single sign-on method for applications. Once integrated, applications can request private, granular data from users, while users can authenticate and selectively reveal their data thanks to zero-knowledge proofs (ZKPs).
Sismo Connect is single sign-on method for applications enabling aggregated data requests to users thanks to privacy. Once integrated, applications can request private, granular data from users, while users can authenticate and selectively reveal their data thanks to zero-knowledge proofs (ZKPs).

The sismoConnect Client is a frontend package that allows to easily request data from the Sismo Data Vault app.
The Sismo Connect Client is a frontend package that allows to easily request data from the Sismo Data Vault app.

Here is the link to the full documentation of the package: [sismoConnect Client package](https://docs.sismo.io/sismo-docs/technical-documentation/sismo-connect/client).
Here is the link to the full documentation of the package: [Sismo Connect Client package](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/client).

You can learn more on sismoConnect [here](https://docs.sismo.io/sismo-docs/readme/sismo-connect).
You can learn more on Sismo Connect [here](https://docs.sismo.io/discover-sismo-connect/empower-your-app).

### Prerequisites

- [Node.js](https://nodejs.org/en/download/) >= 18.15.0 (Latest LTS version)

## Usage

### Installation
Install Sismo Connect Client package in your frontend with npm or yarn:
```bash
# with npm
npm install @sismo-core/sismo-connect-client
# with yarn
yarn add @sismo-core/sismo-connect-client
```

### Import
Import the package in your frontend:
```typescript
import { SismoConnect, SismoConnectClientConfig } from "@sismo-core/sismo-connect-client";

const config: SismoConnectClientConfig = {
// you will need to register an appId in the Factory
appId: "0x8f347ca31790557391cec39b06f02dc2",
}

// create a new SismoConnect instance with the client configuration
const sismoConnect = SismoConnect(config);
```
See the full documentation [here](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/client).

## License

Expand Down
33 changes: 28 additions & 5 deletions packages/sismo-connect-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="https://static.sismo.io/readme/top-main.png" alt="Logo" width="150" height="150" style="borderRadius: 20px">

<h3 align="center">
sismoConnect React
Sismo Connect React
</h3>

<p align="center">
Expand All @@ -23,13 +23,36 @@
</p>
</div>

sismoConnect is a privacy-preserving single sign-on method for applications. Once integrated, applications can request private, granular data from users, while users can authenticate and selectively reveal their data thanks to zero-knowledge proofs (ZKPs).
The Sismo Connect React package is a wrapper of the Sismo Connect Client package which allows to easily request data from the Sismo Data Vault app.

The sismoConnect React package is a wrapper of the sismoConnect Client package which allows to easily request data from the Sismo Data Vault app.
Here is the link to the full documentation of the package: [Sismo Connect React package](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/react).

Here is the link to the full documentation of the package: [sismoConnect React package](https://docs.sismo.io/sismo-docs/technical-documentation/sismo-connect/react).
You can learn more on Sismo Connect [here](https://docs.sismo.io/discover-sismo-connect/empower-your-app).

You can learn more on sismoConnect [here](https://docs.sismo.io/sismo-docs/readme/sismo-connect).
### Prerequisites

- [Node.js](https://nodejs.org/en/download/) >= 18.15.0 (Latest LTS version)

## Usage
### Installation
Install the Sismo Connect React package in your frontend with npm or yarn:
```bash
# with npm
npm install @sismo-core/sismo-connect-react
# with yarn
yarn add @sismo-core/sismo-connect-react
```

### Import
Import the Sismo Connect React package in your frontend:
```typescript
import { SismoConnectClientConfig } from "@sismo-core/sismo-connect-react";

export const sismoConnectConfig: SismoConnectClientConfig = {
appId: "0x8f347ca31790557391cec39b06f02dc2",
};
```
See the full documentation [here](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/react).

## License

Expand Down
39 changes: 34 additions & 5 deletions packages/sismo-connect-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="https://static.sismo.io/readme/top-main.png" alt="Logo" width="150" height="150" style="borderRadius: 20px">

<h3 align="center">
sismoConnect Server
Sismo Connect Server
</h3>

<p align="center">
Expand All @@ -23,13 +23,42 @@
</p>
</div>

sismoConnect is a privacy-preserving single sign-on method for applications. Once integrated, applications can request private, granular data from users, while users can authenticate and selectively reveal their data thanks to zero-knowledge proofs (ZKPs).
Sismo Connect is single sign-on method for applications enabling aggregated data requests to users thanks to privacy. Once integrated, applications can request private, granular data from users, while users can authenticate and selectively reveal their data thanks to zero-knowledge proofs (ZKPs).

The sismoConnect Server is a backend package built on top of the Hydra-S2 Verifier to easily verify proofs from your users off-chain.
The Sismo Connect Server is a backend package built on top of the Hydra-S2 Verifier to easily verify proofs from your users off-chain.

Here is the link to the full documentation of the package: [sismoConnect Server package](https://docs.sismo.io/sismo-docs/technical-documentation/sismo-connect/server).
Here is the link to the full documentation of the package: [Sismo Connect Server package](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/server).

You can learn more on sismoConnect [here](https://docs.sismo.io/sismo-docs/readme/sismo-connect).
You can learn more on Sismo Connect [here](https://docs.sismo.io/discover-sismo-connect/empower-your-app).
### Prerequisites

- [Node.js](https://nodejs.org/en/download/) >= 18.15.0 (Latest LTS version)

## Usage
### Installation
Install Sismo Connect server package in your backend with npm or yarn:
```bash
# with npm
npm i @sismo-core/sismo-connect-server
# with yarn
yarn add @sismo-core/sismo-connect-server
```

### Import
Import the package in your backend:
```typescript
import { SismoConnect, SismoConnectServerConfig } from "@sismo-core/sismo-connect-server";

const config: SismoConnectServerConfig = {
// you will need to register an appId in the Sismo Factory
appId: "0x8f347ca31790557391cec39b06f02dc2",
}

// create a new Sismo Connect instance with the server configuration
const sismoConnect = SismoConnect(config);
```

See the full documentation [here](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/server).

## License

Expand Down
39 changes: 35 additions & 4 deletions packages/sismo-connect-solidity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<img src="https://static.sismo.io/readme/top-main.png" alt="Logo" width="150" height="150" style="borderRadius: 20px">

<h3 align="center">
sismoConnect Solidity
Sismo Connect Solidity
</h3>

<p align="center">
Expand All @@ -24,11 +24,42 @@
</div>


sismoConnect solidity is a Solidity library that allows you to verify the zk-proofs of your sismoConnect Application onchain and simplify the use of the [sismo-connect-onchain-verifier](https://github.com/sismo-core/sismo-connect-onchain-verifier).
Sismo Connect Solidity is a Solidity library that allows you to verify the zk-proofs of your Sismo Connect Application onchain and simplify the use of the [sismo-connect-onchain-verifier](https://github.com/sismo-core/sismo-connect-onchain-verifier).

Here is the link to the full documentation of the library: [sismoConnect Solidity Library](https://docs.sismo.io/sismo-docs/technical-documentation/sismo-connect/solidity-library)
Here is the link to the full documentation of the library: [Sismo Connect Solidity Library](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/solidity)

You can learn more on sismoConnect [here](https://docs.sismo.io/sismo-docs/readme/sismo-connect).
You can learn more on Sismo Connect [here](https://docs.sismo.io/discover-sismo-connect/empower-your-app).

### Prerequisites

- [Node.js](https://nodejs.org/en/download/) >= 18.15.0 (Latest LTS version)
- [Yarn](https://classic.yarnpkg.com/en/docs/install)
- [Foundry](https://book.getfoundry.sh/)

## Usage

### Installation

```bash
# update foundry
foundryup

# install the package
forge install sismo-core/sismo-connect-packages --no-commit

# add the remapping in remappings.txt
echo "\nsismo-connect-solidity/=lib/sismo-connect-packages/packages/sismo-connect-solidity/src/" >> remappings.txt
```

### Import the library
In your solidity file:

```solidity
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.17;
import "sismo-connect-solidity/SismoLib.sol"; // import the library
```

## License

Expand Down

0 comments on commit 08cd13d

Please sign in to comment.