Skip to content

Commit 04d3303

Browse files
committed
Update README.md to reflect roadmap advances
1 parent 90f981d commit 04d3303

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
PythonMonkey is a Mozilla [SpiderMonkey](https://firefox-source-docs.mozilla.org/js/index.html) JavaScript engine embedded into the Python VM,
77
using the Python engine to provide the JS host environment.
88

9-
This product is in an early stage, approximately 75% to MVP as of May 2023. It is under active development by Distributive Corp.,
9+
This product is in an early stage, approximately 80% to MVP as of May 2023. It is under active development by Distributive Corp.,
1010
https://distributive.network/. External contributions and feedback are welcome and encouraged.
1111

1212
The goal is to make writing code in either JS or Python a developer preference, with libraries commonly used in either language
@@ -33,12 +33,12 @@ this package to execute our complex `dcp-client` library, which is written in JS
3333
- [done] NodeJS+NPM-compatible CommonJS module system
3434
- [done] Python strings coerce to JS strings
3535
- [done] Python intrinsics coerce to JS intrinsics
36-
- Python dicts coerce to JS objects
36+
- [done] Python dicts coerce to JS objects
3737
- [done] Python `require` function, returns a coerced dict of module exports
3838
- [done] Python functions coerce to JS function wrappers
3939
- [done] CommonJS module system .py loader, loads Python modules for use by JS
4040
- JS object->Python dict coercion supports inherited-property lookup (via __getattribute__?)
41-
- Python host environment supplies event loop, including EventEmitter, setTimeout, etc.
41+
- [done] Python host environment supplies event loop, including EventEmitter, setTimeout, etc.
4242
- Python host environment supplies XMLHttpRequest (other project?)
4343
- Python host environment supplies basic subsets of NodeJS's fs, path, process, etc, modules; as-needed by dcp-client (other project?)
4444
- Python TypedArrays coerce to JS TypeArrays
@@ -65,7 +65,7 @@ this package to execute our complex `dcp-client` library, which is written in JS
6565

6666
## Using the library
6767

68-
See also: examples/
68+
See also: [examples/](examples/)
6969

7070
### Install from [PyPI](https://pypi.org/project/pythonmonkey/)
7171

@@ -101,8 +101,11 @@ Alternatively, you can build a `wheel` package by running `poetry build --format
101101

102102
# Troubleshooting Tips
103103

104+
## REPL - pmjs
105+
A basic JavaScript shell, `pmjs`, ships with PythonMonkey.
106+
104107
## CommonJS (require)
105-
If you are having trouble with the CommonJS require function, set DEBUG='ctx-module*' and you can see the filenames it tries to laod
108+
If you are having trouble with the CommonJS require function, set environment variable DEBUG='ctx-module*' and you can see the filenames it tries to laod.
106109

107110
### Extra Symbols
108111
Loading the CommonJS subsystem declares some extra symbols which may be helpful in debugging -

0 commit comments

Comments
 (0)