aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index c92df66..3612ef7 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,10 @@ Currently, `socket.js` provides `Socket` which has a few signals and functions (
`examples/helloworld.js` can get you started. Everything in the core API (`socket.js`, `space.js`) should be pretty stable, but please don't hesitate to report a bug.
+## Bugs
+
+Doesn't work with Unicode, somewhat. I think when "astral planes" are involved, it starts to get really buggy, so don't expect it to work when non-BMP characters are involved, even just as part of the world. This is a node issue, not an issue with this specific library, but it can be annoying to deal with. There's also a chance that this is a "just on my machine issue," so take my warning with a grain of salt.
+
## Directory Structure
Top-level scripts are part of the core API: `socket.js` and `space.js` are pretty portable and abstract a lot of the ugly parts of yourworldoftext (like 8x16 tiles).