Skip to content

Commit 5584e0c

Browse files
DOC add readme for wasm wheel (#99)
* DOC add readme for wasm wheel * DOC skip doctest
1 parent 3f6e576 commit 5584e0c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,19 @@ Support Free-Threaded Wheels
9292
FastCan has support for free-threaded (also known as nogil) CPython 3.13.
9393
For more information about free-threaded CPython, check `how to install a free-threaded CPython <https://py-free-threading.github.io/installing_cpython/>`_.
9494

95+
Support WASM Wheels
96+
-------------------
97+
FastCan is compiled to WebAssembly (WASM) wheels using `pyodide <https://github.com/pyodide/pyodide>`_, and they are available on the assets of GitHub releases.
98+
You can try it in a `REPL <https://pyodide.org/en/stable/console.html>`_ directly in a browser.
99+
The WASM wheels of FastCan can be installed by
100+
101+
>>> import micropip # doctest: +SKIP
102+
>>> await micropip.install('URL of the wasm wheel (end with _wasm32.whl)') # doctest: +SKIP
103+
104+
.. note::
105+
Due to the Cross-Origin Resource Sharing (CORS) block in web browsers,
106+
you may need `Allow CORS: Access-Control-Allow-Origin Chrome extension <https://chrome.google.com/webstore/detail/allow-cors-access-control/lhobafahddgcelffkeicbaginigeejlf>`_.
107+
95108

96109
Citation
97110
--------

0 commit comments

Comments
 (0)