diff --git a/.eslintrc.json b/.eslintrc.json index d8f4ae0..86b438e 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -2,7 +2,6 @@ "extends": "./node_modules/gts/", "rules": { "node/no-unpublished-import": ["off"], - "node/no-unpublished-require": ["off"], - "@typescript-eslint/no-explicit-any": ["off"] + "node/no-unpublished-require": ["off"] } } diff --git a/.markdownlint.json b/.markdownlint.json deleted file mode 100644 index 5cbc992..0000000 --- a/.markdownlint.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "ol-prefix": false, - "line-length": false -} diff --git a/README.md b/README.md index 7b89485..506de0c 100644 --- a/README.md +++ b/README.md @@ -44,27 +44,27 @@ Using Circomkit is easy: 1. Install [Circom](https://docs.circom.io/getting-started/installation/). 2. Clone this repo (or use it as a template) and install packages (`yarn` or `npm install`). -3. Write your circuit templates under the `circuits` folder. Your circuit code itself should be templates only; Circomkit programmatically generates the `main` component -4. Write your tests under the `tests` folder. -5. Once you are ready, write the circuit config in [`circuit.config.ts`](./circuit.config.ts). +3. Write your circuit templates under the [circuits](./circuits/) folder. Your circuit code itself should be templates only; Circomkit programmatically generates the `main` component +4. Write your tests under the [tests](./tests/) folder. +5. Once you are ready, write the circuit configurations at [circuits.json](./circuits.json). 6. Use NPM scripts (`yarn