chore(readme): update project readmes with dev docs links (#420)

nucypher · Nov 30, 2023 · c48ab36 · c48ab36
2 parents 64d5bed + ede8b24
commit c48ab36
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -18,19 +18,22 @@ pnpm add @nucypher/taco
 
 ## Tutorial
 
-To learn more, follow the tutorial at Threshold Network's [docs](https://docs.threshold.network/app-development/threshold-access-control-tac/get-started-with-tac).
+To learn more, follow the tutorial at Threshold
+Network's [docs](https://docs.threshold.network/app-development/threshold-access-control-tac/get-started-with-tac).
 
 ## Examples
 
-See [`taco-web/examples`](https://github.com/nucypher/taco-web/tree/main/examples) to find out how to integrate `taco-web` into your favorite web framework.
+See [`taco-web/examples`](https://github.com/nucypher/taco-web/tree/main/examples) to find out how to
+integrate `taco-web` into your favorite web framework.
 
 We also provide demos of TACo applications:
 
 - [taco-demo](https://github.com/nucypher/taco-web/tree/main/demos/taco-demo)
 - [taco-nft-demo](https://github.com/nucypher/taco-web/tree/main/demos/taco-nft-demo)
 
-These examples showcase integration with web applications and an end-to-end flow of creating conditioned encryption, and encrypting & decrypting data.
+These examples showcase integration with web applications utilizing an end-to-end flow of creating encrypted data with associated conditions and enacting access-controlled decryption.
 
 # Contributing
 
-If you would like to contribute to the development of `taco-web`, please see our [Contributing Guide](CONTRIBUTING.md). You can also join our [Discord](http://discord.gg/threshold) and say hello!
+If you would like to contribute to the development of `taco-web`, please see our [Contributing Guide](CONTRIBUTING.md).
+You can also join our [Discord](https://discord.gg/threshold) and say hello!
diff --git a/demos/taco-demo/README.md b/demos/taco-demo/README.md
@@ -13,7 +13,7 @@ pnpm start
 
 ## Usage
 
-In order to run this demo will need a MetaMask with an account funded with some
+In order to run this demo will need a browser wallet with an account funded with some
 $MATIC.
 
 In order to connect with the network, the demo uses a public instances of
@@ -24,12 +24,14 @@ In order to connect with the network, the demo uses a public instances of
 `@nucypher/taco` is in an early release. We recommend **not** using it in
 production _just yet_.
 
-### Tapir - Mumbai Testnet
+### Lynx Testnet
 
-The current release of `@nucypher/taco` supports Ursulas working on Tapir
+The current release of `@nucypher/taco` supports Ursulas working on Lynx (bleeding-edge) test
 network and contracts deployed on Mumbai testnet.
 
 ## References
 
+Please find developer documentation [here](https://docs.threshold.network/app-development/threshold-access-control-tac).
+
 This dApp is based on
 [`useDapp` example](https://github.com/EthWorks/useDapp/tree/master/packages/example).
diff --git a/demos/taco-nft-demo/README.md b/demos/taco-nft-demo/README.md
@@ -13,7 +13,7 @@ pnpm start
 
 ## Usage
 
-In order to run this demo will need a MetaMask with an account funded with some
+In order to run this demo will need a browser wallet with an account funded with some
 $MATIC.
 
 In order to connect with the network, the demo uses a public instances of
@@ -24,12 +24,14 @@ In order to connect with the network, the demo uses a public instances of
 `@nucypher/taco` is in an early release. We recommend **not** using it in
 production _just yet_.
 
-### Tapir - Mumbai Testnet
+### Lynx Testnet
 
-The current release of `@nucypher/taco` supports Ursulas working on Tapir
+The current release of `@nucypher/taco` supports Ursulas working on Lynx (bleeding-edge) test
 network and contracts deployed on Mumbai testnet.
 
 ## References
 
+Please find developer documentation [here](https://docs.threshold.network/app-development/threshold-access-control-tac).
+
 This dApp is based on
 [`useDapp` example](https://github.com/EthWorks/useDapp/tree/master/packages/example).
diff --git a/examples/taco/nextjs/README.md b/examples/taco/nextjs/README.md
@@ -27,6 +27,9 @@ automatically optimize and load Inter, a custom Google Font.
 
 ## Learn More
 
+Please find developer documentation for
+TACo [here](https://docs.threshold.network/app-development/threshold-access-control-tac).
+
 To learn more about Next.js, take a look at the following resources:
 
 - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js

diff --git a/examples/taco/nodejs/README.md b/examples/taco/nodejs/README.md
@@ -5,8 +5,10 @@ This example shows how to use `@nucypher/taco` in Node.js.
 ## Setup
 
 This script needs 3 environment variables, that you can set in the `.env` file:
+
 * `RPC_PROVIDER_URL`: For TACo testnet you should use a Polygon Mumbai endpoint.
-* `ENCRYPTOR_PRIVATE_KEY` and `CONSUMER_PRIVATE_KEY`: Hex-encoded private keys for the Encryptor and the Consumer, respectively. 
+* `ENCRYPTOR_PRIVATE_KEY` and `CONSUMER_PRIVATE_KEY`: Hex-encoded private keys for the Encryptor and the Consumer,
+ respectively.
 
 Default values for these variables are provided in `.env.example`, so you can run:
 
@@ -16,7 +18,6 @@ cp .env.example .env
 
 However, we encourage you to choose your own values for these variables.
 
-
 ## Usage
 
 To run the script, you just need to install this example package and start it:
@@ -25,3 +26,8 @@ To run the script, you just need to install this example package and start it:
 pnpm install
 pnpm start
 ```
+
+## Learn more
+
+Please find developer documentation for
+TACo [here](https://docs.threshold.network/app-development/threshold-access-control-tac).
diff --git a/examples/taco/react/README.md b/examples/taco/react/README.md
@@ -1,11 +1,6 @@
 # `react-taco` integration example
 
 Shows how to integrate `@nucypher/taco` into a React application.
-
-In order to load WASM dependencies of `@nucypher/taco`, we override the
-`react-scripts` configuration with `craco`. For more details, see the
-`craco.config.js` file.
-
 ## Usage
 
 ```bash
@@ -15,3 +10,8 @@ pnpm start
 
 Next, go to [http://127.0.0.1:3000/](http://127.0.0.1:8080/) in your browser and
 inspect the UI and the JS console.
+
+## Learn more
+
+Please find developer documentation for
+TACo [here](https://docs.threshold.network/app-development/threshold-access-control-tac).
diff --git a/examples/taco/webpack-5/README.md b/examples/taco/webpack-5/README.md
@@ -9,5 +9,9 @@ pnpm install
 pnpm start
 ```
 
-Go to [localhost:8080](http://localhost:8080/) in your browser and look in the
-JS console.
+Go to [localhost:8080](http://localhost:8080/) in your browser and look in the JS console.
+
+## Learn more
+
+Please find developer documentation for
+TACo [here](https://docs.threshold.network/app-development/threshold-access-control-tac).
diff --git a/packages/taco/README.md b/packages/taco/README.md
@@ -58,3 +58,8 @@ const decryptedMessage = await decrypt(
  web3Provider.getSigner(),
 );
 ```
+
+## Learn more
+
+Please find developer documentation for
+TACo [here](https://docs.threshold.network/app-development/threshold-access-control-tac).