Skip to content

Commit 1df8a63

Browse files
authored
Update readme. (#359)
* Update readme. * Fix links.
1 parent a5379d9 commit 1df8a63

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,25 @@
33
- **Production @ https://pvm.fluffylabs.dev**
44
- Beta @ https://pvm-debugger.netlify.app/
55

6-
## Requirements
6+
## PVMs support
7+
8+
We have the following PVMs integrated by default.
9+
10+
- [x] [typeberry](https://github.com/fluffylabs/typeberry) - TypeScript implementation (Private)
11+
- [x] [anan-as](https://github.com/tomusdrw/anan-as) - AssemblyScript implementation (as WASM)
12+
- [x] [polkavm](https://github.com/paritytech/polkavm) - Rust implementation (as WASM)
13+
14+
There are few ways how you can add your own PVM to execute the code.
15+
16+
1. Upload WASM (supported interfaces: [wasm-bindgen](https://github.com/FluffyLabs/pvm-debugger/blob/main/src/packages/web-worker/wasmBindgenShell.ts#L4), [assembly script](https://github.com/FluffyLabs/pvm-debugger/blob/main/src/packages/web-worker/wasmAsShell.ts#L5), [Go](https://github.com/FluffyLabs/pvm-debugger/blob/main/src/packages/web-worker/wasmGoShell.ts#L5))
17+
2. Point to an URL with metadata file (details in [#81](https://github.com/FluffyLabs/pvm-debugger/issues/81); example [pvm-metadata.json](https://github.com/tomusdrw/polkavm/blob/gh-pages/pvm-metadata.json))
18+
3. Connect to WebSocket interface: [example & docs](https://github.com/wkwiatek/pvm-ws-rpc).
19+
20+
Details about the API requirements can be found in [#81](https://github.com/FluffyLabs/pvm-debugger/issues/81)
21+
22+
## Development
23+
24+
### Requirements
725

826
```bash
927
$ node --version

src/components/PvmSelect/index.tsx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,11 @@ export const PvmSelect = () => {
243243
</span>
244244
<span className="text-white text-[11px]">
245245
Learn to add your PVM implementation here{" "}
246-
<a href="https://github.com/FluffyLabs/pvm-debugger/issues/81" target="_blank" className="text-brand">
246+
<a
247+
href="https://github.com/FluffyLabs/pvm-debugger?tab=readme-ov-file#pvms-support"
248+
target="_blank"
249+
className="text-brand"
250+
>
247251
<ExternalLink className="inline w-4 mb-1" />
248252
</a>
249253
</span>

0 commit comments

Comments
 (0)