Add details to integration page

2023-10-11 12:14:26 +02:00
parent 022687526a
commit 48e698d080
2 changed files with 12 additions and 4 deletions
@@ -25,7 +25,7 @@ export const GitHubRepoSearch = () => {
      <Box>
        <TextField
          type="text"
-          placeholder="Enter GitHub Repo URL"
+          placeholder="Enter GitHub Repo URL: https://github.com/nymtech/nym/"
          value={repoUrl}
          onChange={(e) => setRepoUrl(e.target.value)}
          size="small"
@@ -14,20 +14,28 @@ If you're unsure where to start, the following set of questions should help you
 
 __1. Does your app rely on using `fetch` for its network traffic and remote connections?__

- Check whether mixFetch can be used by entering your repository's URL below:
+ Check whether `mixFetch` can be used to route your traffic through the mixnet by entering your repository's URL below:

 <GitHubRepoSearch />

-If yes, explore implementing `mixfetch` to route app traffic through the mixnet.
+This should open a window showcasing all your repo's files calling the `fetch` method. The best way to integrate Nym into your application will be where external network calls and RPC happens, for example, something in the lines of `sendRawTransaction` if you have an ETH-compatible wallet or 'JsonRpcClient' if you use CosmJS.
+
+Although you can simply search for any JS `fetch` calls in your code (using our tool above) that are easily replaceable with `mixFetch`, keep in mind that `fetch` is not the only way to make `JSONRPC` or `XHR` calls.
+
+We advise to approach the integration process in a semantic way, searching for a module that is the common denominator for external communication in the codebase. Usually these are API controllers, middlewares or repositories.
+
+While mixFetch is the shortest and easiest way to integrate Nym, a well-modularized codebase should permit the integration of one of our SDK components, which allow much more flexibility and control.



 If not:
+
 __2. Is your app developed in TS/JS or Rust?__
 
- If yes, you can use one of our SDKs and leverage either `mixfetch` (note that this only works for JS/TS at the moment, as we do not currently have a RUST implementation of it) or the `sdk client`to route app traffic through the mixnet. 
+ If yes, you can use one of our SDKs and leverage either `mixfetch` (note that this only works for JS/TS at the moment, as we do not currently have a RUST implementation of it) or the `sdk client` to route app traffic through the mixnet. 
 
 If it is developed in another language:
+
 __3. You can use one of our standalone Nym clients__
 
 All Nym client packages present basically the same capabilities to the privacy application developer. They need to run as a persistent process in order to stay connected and ready to receive any incoming messages from their gateway nodes. They register and authenticate to gateways, and encrypt Sphinx packets.