Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yinrouni authored Mar 20, 2024
1 parent d5d965d commit 14811a5
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,36 @@
English (US) | [简体中文](README.zh-Hans.md)
# Easy PSI

# Easy-PSI
<p align="center">
<a href="./README.zh-CN.md">简体中文</a>|<a href="./README.md">English</a>
</p>

## Development
Easy PSI is a web platform focused on Private Set Intersection(PSI), which is based on [Kuscia](https://github.com/secretflow/kuscia) and [SecretFlow PSI Library](https://github.com/secretflow/psi).

## Documentation

Currently, we only provide detailed documentations in Chinese.

- [Development](./docs/development/build_easypsi_cn.md)
- [User Guide](https://www.secretflow.org.cn/zh-CN/docs/easy-psi/)

## Downloads

For Easy PSI v0.2.0beta or before, you could download installation binaries at https://www.secretflow.org.cn/zh-CN/deployment.

For Easy PSI v0.3.0beta or later, you don't need to install Easy PSI. You could use Easy PSI with Docker. Please check https://hub.docker.com/r/secretflow/easy-psi. We also have mirrors at Alibaba Cloud: secretflow-registry.cn-hangzhou.cr.aliyuncs.com/secretflow/easy-psi.

## Development [frontend]

```bash
pnpm bootstrap
pnpm dev
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for more info.


## Disclaimer

Non-release version of Easy PSI is only for demonstration and should not be used in production environments.
Although this version of Easy PSI covers the basic abilities, there may be some security issues and functional defects due to insufficient functionality and unfinished items in the project.
We welcome your active suggestions and look forward to the official release.

0 comments on commit 14811a5

Please sign in to comment.