Add circom package README.

zkemail · Oct 5, 2023 · 41748b8 · 41748b8
1 parent d74707c
commit 41748b8
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/packages/apis/package.json b/packages/apis/package.json
@@ -15,7 +15,7 @@
     "build-release": "npm run build -- --release",
     "install": "npm run build-release",
     "test": "cargo test",
-    "publish": "yarn npm publish --access=public"
+    "publish": "yarn publish --access=public"
   },
   "license": "MIT",
   "devDependencies": {

diff --git a/packages/circom/README.md b/packages/circom/README.md
@@ -0,0 +1,5 @@
+# zk-regex-circom
+
+Circom circuits for regex verification in [zk-regex](https://github.com/zkemail/zk-regex/tree/main).
+This package contains circom circuits and decomposed regex definitions for common regexes in `./circuits/common` folder.
+
diff --git a/packages/circom/package.json b/packages/circom/package.json
@@ -11,7 +11,7 @@
   ],
   "scripts": {
     "test": "jest",
-    "publish": "yarn npm publish --access=public"
+    "publish": "yarn publish --access=public"
   },
   "dependencies": {
     "commander": "^11.0.0",

diff --git a/packages/compiler/package.json b/packages/compiler/package.json
@@ -15,7 +15,7 @@
     "build-release": "npm run build -- --release",
     "install": "npm run build-release",
     "test": "cargo test",
-    "publish": "yarn npm publish --access=public"
+    "publish": "yarn publish --access=public"
   },
   "license": "MIT",
   "devDependencies": {