diff --git a/README.md b/README.md index 02956c1..9d657ef 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ ## @cross/runtime +[![JSR Version](https://jsr.io/badges/@cross/runtime?v=bust)](https://jsr.io/@cross/runtime) [![JSR Score](https://jsr.io/badges/@cross/runtime/score?v=bust)](https://jsr.io/@cross/runtime/score) + **Cross-Runtime Environment Detection for JavaScript and TypeScript** This package provides a well defined, cross runtime, way to determine details about the current runtime environment (Deno, Bun, Node.js, or browser) along with detailed browser detection. @@ -41,6 +43,45 @@ Version: 1.0.30 You're not running Deno! ``` -**Full Documentation and Installation Instructions** +### Documentation + +**Installation** + +```bash +# Pick your runtime and package manager: +npx jsr add @cross/runtime # Node.js +deno add @cross/runtime # Deno +bunx jsr add @cross/runtime # Bun +``` + +### Supported Environments + +**Runtimes** + +* Deno +* Bun +* Node.js +* Web browsers (Chrome, Firefox, Edge, Safari, Opera, Brave) +* Edge Functions (Cloudflare Workers, Netlify Edge Functions, Fastly Compute@Edge) + +**Operating Systems** + +* Windows +* macOS +* Linux +* Android +* iOS +* Less common Unix variants (AIX, FreeBSD, OpenBSD, etc.) + +**Browsers** + +* Chrome +* Firefox +* Edge +* Safari +* Opera +* Brave + +**Important Notes:** -For comprehensive documentation, including more advanced usage and examples, please visit the documentation at jsr.io (if your are not already there): [https://jsr.io/@cross/runtime](https://jsr.io/@cross/runtime). +* **Additional Functionality:** Beyond detection, the `dumpSystemInfo` function logs the information, and the `getsystemInfo` function provides a JSON representation. \ No newline at end of file