Update README.md
All checks were successful
Release / build_and_release (push) Successful in 57s

This commit is contained in:
b 2024-04-15 18:31:37 +00:00
parent 3bf2437d17
commit f4c26945c1

View File

@ -1,30 +1,18 @@
# React + TypeScript + Vite # SIGit
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. SIGit is a decentralised document signing tool, currently under active development. Document Signing is a $30 billion industry yet has two major structural flaws:
Currently, two official plugins are available: - Your signing provider can read ALL your documents (and even use them to train their proprietary AI)
- Your signatories do not own their keys (cloud email and/or SMS are **not** secure)
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh The trouble, of course, is all the trust that is required to make things work.
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
## Expanding the ESLint configuration SIGit is a signing technology that is more *secure* and *private* than any off-the-shelf self-hosted or SaaS based solution. This is a result of two design factors:
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: 1. The use of NOSTR for identity and key management (not your keys, not your signature)
2. Encryption of documents at every stage (we have no idea what you are signing)
- Configure the top-level `parserOptions` property like this: Of course, being built on the Nostr relay network, you can sign documents and build business relationships even in the most adversarial of regulatory environments.
```js We expect to have an MVP by the summer, if you are interested in being an early tester, do reach out on https://chat.sigit.io
export default {
// other rules...
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
project: ['./tsconfig.json', './tsconfig.node.json'],
tsconfigRootDir: __dirname,
},
}
```
- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list