Skip to content

Commit

Permalink
docs: udpate README
Browse files Browse the repository at this point in the history
  • Loading branch information
aesedepece committed Apr 9, 2022
1 parent f01fd1d commit efb40a7
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
[![Docs](https://docs.rs/scriptful/badge.svg)](https://docs.rs/scriptful)
![License](https://img.shields.io/crates/l/scriptful.svg)

___Scriptful_ is a minimalist `no_std` stack machine for interpreting scripts written with domain specific interpreted languages.__
___Scriptful_ is a minimalist `no_std`, zero dependency stack machine for interpreting scripts written with domain
specific interpreted languages.__

This library is heavily inspired by the [Forth] programming language and [Script][BitcoinScript] (the scripting language in Bitcoin).

Expand Down Expand Up @@ -79,12 +80,8 @@ assert_eq!(result, Some(&Integer(3)));

## Known limitations

- [Stacks][Stack] are currently implemented using a fixed-length, actually stack-allocated vectors using [smallvec].
Thus the `main` sub-stack is limited to 64 values, and the `alt` sub-stack can only hold up to 8.
- _Beware of unwraps!_ This is a proof-of-concept and it is modelled to panic upon errors.
Making the library safe for production usage is in the near horizon though.
- The possible value types that can be pushed into the [Stack] is not generic nor customizable.
Such feature will only be added if someone actually requests it.

## License

Expand All @@ -105,4 +102,4 @@ See [LICENSE-APACHE] and [LICENSE-MIT], and [COPYRIGHT] for details.
[enum]: https://doc.rust-lang.org/std/keyword.enum.html
[LICENSE-APACHE]: LICENSE-APACHE
[LICENSE-MIT]: LICENSE-MIT
[COPYRIGHT]: COPYRIGHT
[COPYRIGHT]: COPYRIGHT

0 comments on commit efb40a7

Please sign in to comment.