Skip to content

Commit b719d8e

Browse files
authored
Update README.md with PythonMonkey installation and description
1 parent 932956b commit b719d8e

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
11
# PythonMonkey Examples
22

33
## What is PythonMonkey
4-
- TODO
4+
[PythonMonkey](https://pythonmonkey.io/) is a Python library for executing JavaScript in Python
5+
and executing Python in JavaScript. It uses [Mozilla's SpiderMonkey](https://firefox-source-docs.mozilla.org/js/index.html)
6+
JavaScript Engine and shares memory with Python for fast execution.
7+
8+
Check out [PythonMonkey on GitHub](https://github.com/Distributive-Network/PythonMonkey#pythonmonkey)!
59

610
## Installation
711
- requires Python 3.8 or higher
8-
`pip install pythonmonkey`
9-
- TODO fill this out when everything is ready
12+
```bash
13+
pip install pythonmonkey
14+
```
15+
16+
## Running Examples
17+
- Run the examples via `python3`. Refer to the README.md files in each of the directories for more information.
1018

1119
## Examples:
1220
- `hello-world-eval.py`
1321
- A "Hello, World" which evaluates a string in JavaScript
22+
- Run with `python3 hello-world-eval.py`
1423
- `function-call-eval.py`
1524
- Calling a JavaScript function in Python
25+
- Run with `python3 function-call-eval.py`
1626
- `function-passing-eval.py`
1727
- Calling a Python function in a JavaScript function from Python
28+
- Run with `python3 function-passing-eval.py`
1829
- `require-js-file-from-py/`
1930
- Loading a JavaScript module from Python
2031
- `require-py-file-from-js/`
@@ -25,4 +36,6 @@
2536
- Calling JavaScript code that uses NPM modules
2637
- `load-wasm-from-py/`
2738
- Loading a WebAssembly module in Python and calling WASM function
39+
- `promises/`
40+
- Using JavaScript promises in Python
2841

0 commit comments

Comments
 (0)