numbl 0.0.12 → 0.0.15

package/README.md

@@ -1,12 +1,16 @@
 # Numbl
 
-Numbl is an open-source numerical computing environment that aims to be compatible with Matlab. It works by compiling `.m` source code to JavaScript and executing it directly. It can work in the browser or on the command line.
+Numbl is an open-source numerical computing environment that aims to be compatible with Matlab.
 
 **Early stage project.** Numbl is under active development and new functionality is being added regularly.
 
 ## Try it in the browser
 
-You can try numbl directly in the browser at <https://magland.github.io/numbl> — no installation required. All execution happens locally in your browser. Note that the browser version has limited functionality and is slower than the CLI.
+You can try numbl directly in the browser at <https://numbl.org> — no installation required. All execution happens locally in your browser. Note that the browser version has limited functionality and is slower than the desktop/command-line version.
+
+## Embedding in web pages
+
+Numbl scripts can be embedded in HTML and Markdown pages (including GitHub Pages). See the [numbl-embed-example](https://magland.github.io/numbl-embed-example/) for usage info and a [live demo](https://magland.github.io/numbl-embed-example/example1).
 
 ## Installation
 
@@ -14,7 +18,7 @@ You can try numbl directly in the browser at <https://magland.github.io/numbl>
 npm install -g numbl
 ```
 
-To enable fast linear algebra (matrix inverse, SVD, eigenvalues, etc.), build the native LAPACK addon:
+To enable fast linear algebra, build the native LAPACK addon:
 
 ```bash
 # Prerequisites: C++ compiler, libopenblas-dev, libfftw3-dev (or equivalents for your OS)
@@ -26,38 +30,12 @@ numbl build-addon
 ```bash
 numbl                          # interactive REPL
 numbl run script.m             # run a .m file
-numbl eval "disp(eye(3))"     # evaluate inline code
+numbl eval "disp(eye(3))"      # evaluate inline code
 numbl info                     # print info (JSON), including native addon status
 numbl list-builtins            # list available built-in functions
 numbl --help                   # show all commands and options
 ```
 
-## Try it with Docker
-
-Run the REPL instantly — no installation required:
-
-```bash
-docker run -it node:22 npx numbl
-```
-
-With plotting support (open http://localhost:8234 in your browser):
-
-```bash
-docker run -it -p 8234:8234 node:22 npx numbl --plot-port 8234
-```
-
-With native LAPACK support for fast linear algebra:
-
-```bash
-docker run -it node:22 bash -c "apt-get update && apt-get install -y libopenblas-dev libfftw3-dev && npx numbl build-addon && npx numbl"
-```
-
-With both LAPACK and plotting:
-
-```bash
-docker run -it -p 8234:8234 node:22 bash -c "apt-get update && apt-get install -y libopenblas-dev libfftw3-dev && npx numbl build-addon && npx numbl --plot-port 8234"
-```
-
 ## Upgrading
 
 ```bash
@@ -66,16 +44,6 @@ npm install -g numbl@latest
 
 Note: if you previously built the native addon, you'll need to run `numbl build-addon` again after upgrading.
 
-## Documentation
-
-- [Overview](docs/overview.md) — What numbl is and how to use it
-- [Architecture](docs/architecture.md) — How the compiler pipeline works
-- [Adding built-in functions](docs/adding-builtins.md) — How to contribute new built-ins
-- [Test scripts](docs/test-scripts.md) — Writing and running `.m` integration tests
-- [Development](docs/development.md) — Setting up local development
-- [Performance](docs/performance.md) — How numbl achieves computational efficiency
-- [Documentation guidelines](docs/documentation-guidelines.md) — Conventions for writing docs
-
 ## Authors
 
 Jeremy Magland and Dan Fortunato, Center for Computational Mathematics, Flatiron Institute.
@@ -86,4 +54,4 @@ Apache 2.0.
 
 ## Acknowledgements
 
-See [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md).
+See [acknowledgements.md](docs/acknowledgements.md).