Skip to content

Commit

Permalink
xFix badges
Browse files Browse the repository at this point in the history
  • Loading branch information
Hexagon committed Mar 11, 2024
1 parent 2826741 commit eb36c67
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.

0 comments on commit eb36c67

Please sign in to comment.