From 0e89de4d9a8ed2fa9a3c69df8b99f1ea271eab0b Mon Sep 17 00:00:00 2001
From: Jimmy Chu <898091+jimmychu0807@users.noreply.github.com>
Date: Tue, 24 Sep 2024 07:42:36 +0800
Subject: [PATCH] Updated README and change the tld from vercel.app to
jimmychu0807.hk (#54)
* updated
* updated
---
README.md | 17 +++++++++--------
apps/web/src/config/index.ts | 2 +-
package.json | 2 +-
3 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 16a4a27..86506de 100644
--- a/README.md
+++ b/README.md
@@ -11,17 +11,17 @@
-| The repository is divided into two components: [web](./apps/web), [contracts](./apps/contracts), and [circuits](./apps/circuits). The contracts have been deployed on Optimism Sepolia. |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| The repository is divided into three components: [web](./apps/web), [contracts](./apps/contracts), and [circuits](./apps/circuits).
The contracts have been deployed on Optimism Sepolia. |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
This repo is modified from [Semaphore Boilerplate](https://github.com/semaphore-protocol/boilerplate)
-- 👇 Click below to check the project explanation video.
+- 🎮 Project Website: **https://guessing.jimmychu0807.hk**
+- 📝 [Project Write Up](https://jimmychu0807.hk/pse-core-capstone-project)
+- 🧑🏻🏫 [Project Presentation](https://docs.google.com/presentation/d/1SE4omIJJaYBLAXkV0Ew6o47RLgoQ8pTcIkkv1tFMbik/edit?usp=sharing)
+- 📽️ Project Explanation Video
- [![Project Explanation Video](http://img.youtube.com/vi/MrhGMfzsAX0/0.jpg)](https://youtu.be/MrhGMfzsAX0 "Project Explanation Video")
-
-- [Project Presentation](https://docs.google.com/presentation/d/1SE4omIJJaYBLAXkV0Ew6o47RLgoQ8pTcIkkv1tFMbik/edit?usp=sharing)
-- [Project Write Up](https://jimmychu0807.hk/pse-core-capstone-project)
+
## 📜 Usage
@@ -49,5 +49,6 @@ yarn dev
Key components for writing circuits
+- [circom](https://docs.circom.io/)
- [circomkit](https://github.com/erhant/circomkit/tree/main)
-- [hardhat-circom](https://github.com/projectsophon/hardhat-circom)
+- [snarkjs](https://github.com/iden3/snarkjs)
diff --git a/apps/web/src/config/index.ts b/apps/web/src/config/index.ts
index da7ceb3..cab6a1a 100644
--- a/apps/web/src/config/index.ts
+++ b/apps/web/src/config/index.ts
@@ -42,7 +42,7 @@ export const RpcUrls = {
export const projectInfo = {
name: "PSE Capstone - Number Guessing Game",
desc: "Guessing game using zk-SNARKS",
- homepage: "https://pse-core-capstone.vercel.app",
+ homepage: "https://guessing.jimmychu0807.hk",
authorHomepage: "https://linktr.ee/jimmychu0807",
github: "https://github.com/jimmychu0807/PSE-core-capstone",
image: "https://avatars.githubusercontent.com/u/898091?v=4",
diff --git a/package.json b/package.json
index b9ce043..1cb9f35 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
"name": "@jimmychu0807/guessing-game",
"description": "A mini-game of guessing number",
"license": "MIT",
- "homepage": "https://pse-core-capstone.vercel.app",
+ "homepage": "https://guessing.jimmychu0807.hk",
"repository": "https://github.com/jimmychu0807/PSE-core-hackathon.git",
"bugs": "https://github.com/jimmychu0807/PSE-core-hackathon/issues",
"private": true,