# <picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/logo-dark.png"><img align="left" width="120px" src="docs/images/logo-light.png"></picture> Scheme-rs: Embedded Scheme for the Rust Ecosystem
[<img alt="github" src="https://img.shields.io/badge/github-maplant/scheme--rs-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/maplant/scheme-rs)
[<img alt="crates.io" src="https://img.shields.io/crates/v/scheme-rs.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/scheme-rs)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-scheme--rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/scheme-rs)
Scheme-rs is an implementation of the
[R6RS](https://www.r6rs.org/final/r6rs.pdf) specification of the [Scheme programming
language](https://en.wikipedia.org/wiki/Scheme_(programming_language)) that is
designed to embedded within sync and async Rust.
Scheme-rs is safe, fast, and does not sacrifice modern conveniences.
## Features:
- **Modern**: scheme-rs is a modern scheme implementation of the R6RS standard and includes
advanced features such as [delimited continuations](https://en.wikipedia.org/wiki/Delimited_continuation).
- **Fast**: scheme-rs uses JIT compilation to provide performance on par with
other modern scheme implementations.
- **Easy to use**: scheme-rs makes it trivial to define Rust functions and data
structures that are accessible from scheme code and vice-versa.
- **Safe**: scheme-rs provides a completely safe API that is impossible to
misuse.
- **Supports both async and sync Rust**: by enabling the `async` feature flag
it becomes possible (and easy) to define async scheme functions in Rust.
## Getting started:
For embedding scheme-rs in your Rust project, [take a look at the API documentation](https://docs.rs/scheme-rs/latest/scheme_rs/).
For installing scheme-rs as a standalone executable, cargo can be used:
```console
$ cargo install scheme-rs
```
To enable async features, install with the `async` and `tokio` features:
``` console
$ cargo install scheme-rs --features "async,tokio"
```
## Documentation
- [API documentation](https://docs.rs/scheme-rs/latest/scheme_rs/)
- [Language reference](<https://www.scheme.rs/Language Reference/>)
## Contributing
If you have any questions or comments about the project, feel free to join
[the scheme-rs discord server](https://discord.gg/sR4TttzGv5).
