diff --git a/src/inproxy/README.md b/src/inproxy/README.md index 6151fa3..71958f2 100644 --- a/src/inproxy/README.md +++ b/src/inproxy/README.md @@ -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).