Update docs

Author: richarddavison

API.md

@@ -1,6 +1,7 @@
 # API documentation
 
-The long term goal for LLRT is to become [Winter CG compliant](https://github.com/wintercg/admin/blob/main/proposals.md). Not every API from node will be supported.
+> [!NOTE] 
+> The long term goal for LLRT is to become [Winter CG compliant](https://github.com/wintercg/admin/blob/main/proposals.md). Not every API from Node.js will be supported.
 
 ## buffer
 
@@ -16,6 +17,9 @@ Everything else inherited from [Uint8Array](https://developer.mozilla.org/en-US/
 
 ## child_process
 
+> [!WARNING] 
+> `spawn` uses native streams that is not 100% compatible with the Node.js Streams API.
+
 [spawn](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options)
 
 ## crypto
@@ -40,10 +44,13 @@ Everything else inherited from [Uint8Array](https://developer.mozilla.org/en-US/
 
 Available globally
 
-[fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) _There are some differences with the [WHATWG standard](https://fetch.spec.whatwg.org). Mainly browser specific behavior is removed:_
-* `keepalive` is always true
-* `body` can only be `string`, `Array`, `ArrayBuffer` or `Uint8Array`
-* `mode`, `credentials`,  `referrerPolicy`, `priority`, `cache` is not available/applicable
+[fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch)
+
+> [!IMPORTANT]  
+> There are some differences with the [WHATWG standard](https://fetch.spec.whatwg.org). Mainly browser specific behavior is removed:
+> * `keepalive` is always true
+> * `body` can only be `string`, `Array`, `ArrayBuffer` or `Uint8Array`
+> * `mode`, `credentials`,  `referrerPolicy`, `priority`, `cache` is not available/applicable
 
 ## fs/promises
 
@@ -76,7 +83,10 @@ export function decode(value:string):Uint8Array
 
 ## module
 
-[createRequire](https://nodejs.org/api/module.html#modulecreaterequirefilename) _Require is available from esm modules natively. This function is just for compatibility_
+[createRequire](https://nodejs.org/api/module.html#modulecreaterequirefilename) 
+
+> [!NOTE] 
+> `require` is available from esm modules natively. This function is just for compatibility
 
 ## os
 
@@ -112,7 +122,7 @@ export function decode(value:string):Uint8Array
 
 ## timers
 
-Also available globally
+_Also available globally_
 
 [setImmediate](https://nodejs.org/api/timers.html#setimmediatecallback-args)
 
@@ -128,12 +138,12 @@ Also available globally
 
 ## util
 
-_Supported encodings:  hex, base64, utf8, iso88591_
+> [!IMPORTANT] 
+> Supported encodings:  hex, base64, utf8, iso88591.
+> Supported methods: `encode` & `decode`
 
 [TextEncoder](https://nodejs.org/api/util.html#class-utiltextdecoder)
 
-_Supports only `decode`_
-
 [TextDecoder](https://nodejs.org/api/util.html#class-utiltextdecoder)
 
 ## uuid
@@ -179,14 +189,15 @@ export class XMLParser(options?: XmlParserOptions){
 
 ## net
 
-_These APIs uses native streams that is not 100% compatible with the Node.js Streams API._
+> [!WARNING] 
+> These APIs uses native streams that is not 100% compatible with the Node.js Streams API. Server APIs like `createSever` provides limited functionality useful for testing purposes. Serverless applications typically don't expose servers. Some server options are not supported:
+`highWaterMark`, `pauseOnConnect`, `keepAlive`, `noDelay`, `keepAliveInitialDelay`
 
 [createConnection](https://nodejs.org/api/net.html#netcreateconnection)
 
 [connect](https://nodejs.org/api/net.html#netconnect)
 
-[createServer](https://nodejs.org/api/net.html#netcreateserveroptions-connectionlistener) _This module provides limited functionality useful for testing purposes. Serverless applications typically don't expose servers. Some server options are not supported:_
-`highWaterMark`, `pauseOnConnect`, `keepAlive`, `noDelay`, `keepAliveInitialDelay`
+[createServer](https://nodejs.org/api/net.html#netcreateserveroptions-connectionlistener)
 
 ## Misc Global objects
 

README.md

@@ -6,7 +6,8 @@ LLRT (**L**ow **L**atency **R**un**t**ime) is a lightweight JavaScript runtime d
 
 It's is built in Rust, utilizing QuickJS as JavaScript engine, ensuring efficient memory usage and swift startup.
 
-LLRT is an experimental package. It is subject to change and intended only for evaluation purposes.
+> [!WARNING]
+> LLRT is an **experimental** package. It is subject to change and intended only for evaluation purposes.
 
 <sub>LLRT - [DynamoDB Put, ARM, 128MB](example/functions/src/v3-lib.mjs):<sub>
 ![DynamoDB Put LLRT](./benchmarks/llrt-ddb-put.png "LLRT DynamoDB Put")
@@ -28,8 +29,9 @@ Choose `Custom Runtime on Amazon Linux 2023`, upload `llrt-lambda-arm64.zip` or
 
 Thats it 🎉
 
-**Please note: Even though LLRT supports [ES2020](https://262.ecma-international.org/11.0/) it's is NOT a drop in replacement for Node.js. Consult [Compatibility matrix](#compatibility-matrix) and [API](API.md) for more details.
-All dependencies should be bundled for a `browser` platform and mark included `@aws-sdk` packages as external.**
+> [!IMPORTANT]
+> Even though LLRT supports [ES2020](https://262.ecma-international.org/11.0/) it's is **NOT** a drop in replacement for Node.js. Consult [Compatibility matrix](#compatibility-matrix) and [API](API.md) for more details.
+> All dependencies should be bundled for a `browser` platform and mark included `@aws-sdk` packages as external.
 
 ## Testing & ensuring compatibility
 
@@ -45,7 +47,8 @@ The test runner also has support for filters. Using filters is as simple as addi
 
 ## Compatibility matrix
 
-_LLRT only support a fraction of the Node.js APIs. It is **NOT** a drop in replacement for Node.js, nor will it ever be. Below is a high level overview of partially supported APIs and modules. For more details consult the [API](API.md) documentation_
+> [!NOTE] 
+> LLRT only support a fraction of the Node.js APIs. It is **NOT** a drop in replacement for Node.js, nor will it ever be. Below is a high level overview of partially supported APIs and modules. For more details consult the [API](API.md) documentation
 
 |               | Node.js                                  | LLRT ⚠️  |
 | ------------- | ---------------------------------------- | ----- |
@@ -177,7 +180,8 @@ V3 SDK packages not included in the list bellow have to be bundled with your sou
 
 Same principle as dependencies applies when using TypeScript. TypeScript must be bundled and transpiled into ES2020 JavaScript.
 
-_Note that LLRT will not support running TypeScript without transpilation. This is by design for performance reasons. Transpiling requires CPU and memory that adds latency and cost during execution. This can be avoided if done ahead of time during deployment._
+> [!NOTE] 
+> LLRT will not support running TypeScript without transpilation. This is by design for performance reasons. Transpiling requires CPU and memory that adds latency and cost during execution. This can be avoided if done ahead of time during deployment.
 
 ## Rationale