Skip to content

Commit

Permalink
add README section about mock module
Browse files Browse the repository at this point in the history
  • Loading branch information
tmgrask committed Sep 25, 2024
1 parent 1e21b21 commit a38bb14
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions src/inproxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,18 @@ emitter.addListener("ConduitEvent", (event) => {
}
});
```

## Mock Module

To help with developing and testing the UI, there is a mocked implementation of
the module available in `mockModule.ts`. To use this, replace the import in the
`context.tsx` file:

```
- import { ConduitModule } from "@/src/inproxy/module";
+ import { ConduitModule } from "@/src/inproxy/mockModule";
```

The mock simulates inproxy activity and emits events like the real module, but
without actual users connecting to an InProxy (and without running any native
code).

0 comments on commit a38bb14

Please sign in to comment.