fix readme intro as per suggestions

rscarson · Jul 8, 2024 · 990fa8c · 990fa8c
1 parent 8a6dc3b
commit 990fa8c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -7,6 +7,9 @@
 <!-- cargo-rdme start -->
 
 This crate is meant to provide a quick and simple way to integrate a runtime javacript or typescript component from within rust.
+It uses the v8 engine through the deno_core crate, and is meant to be as simple as possible to use without sacrificing flexibility or performance.
+
+I also have attempted to abstract away the v8 engine details so you can for the most part operate directly on rust types.
 
 - **By default, the code being run is entirely sandboxed from the host, having no filesystem or network access.**
     - It can be extended to include those capabilities and more if desired - please see the 'web' feature, and the 'runtime_extensions' example

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,4 +1,7 @@
 //! This crate is meant to provide a quick and simple way to integrate a runtime javacript or typescript component from within rust.
+//! It uses the v8 engine through the deno_core crate, and is meant to be as simple as possible to use without sacrificing flexibility or performance.
+//!
+//! I also have attempted to abstract away the v8 engine details so you can for the most part operate directly on rust types.
 //!
 //! - **By default, the code being run is entirely sandboxed from the host, having no filesystem or network access.**
 //!     - It can be extended to include those capabilities and more if desired - please see the 'web' feature, and the 'runtime_extensions' example