Update docs.
This commit is contained in:
13
README.md
13
README.md
@@ -7,10 +7,13 @@ Rhai - Embedded Scripting for Rust
|
||||
[](https://crates.io/crates/rhai/)
|
||||
[](https://crates.io/crates/rhai/)
|
||||
[](https://docs.rs/rhai/)
|
||||
[](https://discord.gg/yZMKAQ)
|
||||
[](https://www.reddit.com/r/Rhai)
|
||||
|
||||
Rhai is an embedded scripting language and evaluation engine for Rust that gives a safe and easy way
|
||||
to add scripting to any application.
|
||||
|
||||
|
||||
Supported targets and builds
|
||||
---------------------------
|
||||
|
||||
@@ -19,6 +22,7 @@ Supported targets and builds
|
||||
* `no-std`
|
||||
* Minimum Rust version 1.45
|
||||
|
||||
|
||||
Standard features
|
||||
-----------------
|
||||
|
||||
@@ -41,13 +45,15 @@ Standard features
|
||||
* Serialization/deserialization support via [serde](https://crates.io/crates/serde) (requires the `serde` feature).
|
||||
* Support for [minimal builds](https://schungx.github.io/rhai/start/builds/minimal.html) by excluding unneeded language [features](https://schungx.github.io/rhai/start/features.html).
|
||||
|
||||
Protection against attacks
|
||||
--------------------------
|
||||
|
||||
Protected against attacks
|
||||
-------------------------
|
||||
|
||||
* Sand-boxed - the scripting engine, if declared immutable, cannot mutate the containing environment unless [explicitly permitted](https://schungx.github.io/rhai/patterns/control.html).
|
||||
* Rugged - protected against malicious attacks (such as [stack-overflow](https://schungx.github.io/rhai/safety/max-call-stack.html), [over-sized data](https://schungx.github.io/rhai/safety/max-string-size.html), and [runaway scripts](https://schungx.github.io/rhai/safety/max-operations.html) etc.) that may come from untrusted third-party user-land scripts.
|
||||
* Track script evaluation [progress](https://schungx.github.io/rhai/safety/progress.html) and manually terminate a script run.
|
||||
|
||||
|
||||
For those who actually want their own language
|
||||
---------------------------------------------
|
||||
|
||||
@@ -56,6 +62,7 @@ For those who actually want their own language
|
||||
* Define [custom operators](https://schungx.github.io/rhai/engine/custom-op.html).
|
||||
* Extend the language with [custom syntax](https://schungx.github.io/rhai/engine/custom-syntax.html).
|
||||
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
@@ -65,12 +72,14 @@ To build _The Book_, first install [`mdbook`](https://github.com/rust-lang/mdBoo
|
||||
and [`mdbook-tera`](https://github.com/avitex/mdbook-tera) (for templating).
|
||||
Running `mdbook build` builds it.
|
||||
|
||||
|
||||
Playground
|
||||
----------
|
||||
|
||||
An [Online Playground](https://alvinhochun.github.io/rhai-demo/) is available with syntax-highlighting editor.
|
||||
Scripts can be evaluated directly from the editor.
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
|
Reference in New Issue
Block a user