Update README and authors/contributors.

zkemail · Oct 5, 2023 · 7c3777e · 7c3777e
1 parent 93f7db3
commit 7c3777e
Show file tree

Hide file tree

Showing 8 changed files with 61 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -1,12 +1,18 @@
 {
   "name": "zk-regex",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "private": true,
   "description": "zk regex circuit for content attestation",
   "main": "node-apis/index.node",
   "workspaces": [
     "packages/*"
   ],
+  "contributors": [
+    "Javier Su <javier.su.weijie@gmail.com>",
+    "Kata Choi <kata.choi@gmail.com>",
+    "Sora Suegami <suegamisora@gmail.com>",
+    "Yush G <aayushg@mit.edu>"
+  ],
   "scripts": {
     "install": "cargo install --path ./packages/compiler",
     "test": "yarn workspaces -pt run test"

diff --git a/packages/apis/Cargo.toml b/packages/apis/Cargo.toml
@@ -1,9 +1,15 @@
 [package]
 name = "zk-regex-apis"
-version = "0.1.0"
+version = "1.0.0"
 license = "MIT"
 edition = "2018"
 exclude = ["index.node"]
+authors = [
+    "Javier Su <javier.su.weijie@gmail.com>",
+    "Kata Choi <kata.choi@gmail.com>",
+    "Sora Suegami <suegamisora@gmail.com>",
+    "Yush G <aayushg@mit.edu>",
+]
 
 [lib]
 crate-type = ["rlib", "cdylib"]

diff --git a/packages/apis/README.md b/packages/apis/README.md
@@ -1,5 +1,7 @@
 # zk-regex-apis
 
+Helpful nodejs/Rust APIs in [zk-regex](https://github.com/zkemail/zk-regex/tree/main).
+
 This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
 
 ## Installing zk-regex-apis

diff --git a/packages/apis/package.json b/packages/apis/package.json
@@ -1,14 +1,21 @@
 {
   "name": "zk-regex-apis",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "",
+  "contributors": [
+    "Javier Su <javier.su.weijie@gmail.com>",
+    "Kata Choi <kata.choi@gmail.com>",
+    "Sora Suegami <suegamisora@gmail.com>",
+    "Yush G <aayushg@mit.edu>"
+  ],
   "main": "index.node",
   "scripts": {
     "build": "cargo-cp-artifact -nc index.node -- cargo build --message-format=json-render-diagnostics",
     "build-debug": "npm run build --",
     "build-release": "npm run build -- --release",
     "install": "npm run build-release",
-    "test": "cargo test"
+    "test": "cargo test",
+    "publish": "yarn npm publish --access=public"
   },
   "author": "",
   "license": "MIT",

diff --git a/packages/circom/package.json b/packages/circom/package.json
@@ -2,8 +2,15 @@
   "name": "zk-regex-circom",
   "version": "1.0.0",
   "license": "MIT",
+  "contributors": [
+    "Javier Su <javier.su.weijie@gmail.com>",
+    "Kata Choi <kata.choi@gmail.com>",
+    "Sora Suegami <suegamisora@gmail.com>",
+    "Yush G <aayushg@mit.edu>"
+  ],
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "publish": "yarn npm publish --access=public"
   },
   "dependencies": {
     "commander": "^11.0.0",

diff --git a/packages/compiler/Cargo.toml b/packages/compiler/Cargo.toml
@@ -1,7 +1,12 @@
 [package]
 name = "zk-regex-compiler"
-version = "0.1.0"
-authors = ["Sora Suegami"]
+version = "1.0.0"
+authors = [
+    "Javier Su <javier.su.weijie@gmail.com>",
+    "Kata Choi <kata.choi@gmail.com>",
+    "Sora Suegami <suegamisora@gmail.com>",
+    "Yush G <aayushg@mit.edu>",
+]
 license = "MIT"
 edition = "2018"
 # exclude = ["index.node"]

diff --git a/packages/compiler/README.md b/packages/compiler/README.md
@@ -1,10 +1,12 @@
-# zk-regex-apis
+# zk-regex-compiler
+
+A compiler CLI in [zk-regex](https://github.com/zkemail/zk-regex/tree/main).
 
 This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
 
-## Installing zk-regex-apis
+## Installing zk-regex-compiler
 
-Installing zk-regex-apis requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
+Installing zk-regex-compiler requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
 
 You can install the project with npm. In the project directory, run:
 
@@ -14,7 +16,7 @@ $ npm install
 
 This fully installs the project, including installing any dependencies and running the build.
 
-## Building zk-regex-apis
+## Building zk-regex-compiler
 
 If you have already installed the project and only want to run the build, run:
 
@@ -24,9 +26,12 @@ $ npm run build
 
 This command uses the [cargo-cp-artifact](https://github.com/neon-bindings/cargo-cp-artifact) utility to run the Rust build and copy the built library into `./index.node`.
 
-## Exploring zk-regex-apis
+## CLI Usage
+Please see "Compiler CLI" section in [zk-regex](https://github.com/zkemail/zk-regex/tree/main).
+
+## Exploring zk-regex-compiler
 
-After building zk-regex-apis, you can explore its exports at the Node REPL:
+After building zk-regex-compiler, you can explore its exports at the Node REPL:
 
 ```sh
 $ npm install
@@ -70,7 +75,7 @@ Runs the unit tests by calling `cargo test`. You can learn more about [adding te
 The directory structure of this project is:
 
 ```
-zk-regex-apis/
+zk-regex-compiler/
 ├── Cargo.toml
 ├── README.md
 ├── index.node

diff --git a/packages/compiler/package.json b/packages/compiler/package.json
@@ -1,14 +1,21 @@
 {
   "name": "zk-regex-compiler",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "",
   "main": "index.node",
+  "contributors": [
+    "Javier Su <javier.su.weijie@gmail.com>",
+    "Kata Choi <kata.choi@gmail.com>",
+    "Sora Suegami <suegamisora@gmail.com>",
+    "Yush G <aayushg@mit.edu>"
+  ],
   "scripts": {
     "build": "cargo-cp-artifact -nc index.node -- cargo build --message-format=json-render-diagnostics",
     "build-debug": "npm run build --",
     "build-release": "npm run build -- --release",
     "install": "npm run build-release",
-    "test": "cargo test"
+    "test": "cargo test",
+    "publish": "yarn npm publish --access=public"
   },
   "author": "",
   "license": "MIT",