Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add extra link to runtimes to make it more discoverable #185

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ configuration as the port for WebSocket protocol is NOT 4222.

# Installation

For a quick overview of the libraries and how to install them, see
[runtimes.md](../runtimes.md).

If you are not implementing a NATS client compatible module, you can use this
repository to view the documentation of the NATS core functionality. Your NATS
client instance already uses and re-exports the module implemented here, so
Expand Down
3 changes: 3 additions & 0 deletions jetstream/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ resources.

## Installation

For a quick overview of the libraries and how to install them, see
[runtimes.md](../runtimes.md).

Note that this library is distributed in two different registries:

- npm a node-specific library supporting CJS (`require`) and ESM (`import`)
Expand Down
3 changes: 3 additions & 0 deletions kv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ familiar to many application developers.

## Installation

For a quick overview of the libraries and how to install them, see
[runtimes.md](../runtimes.md).

Note that this library is distributed in two different registries:

- npm a node-specific library supporting CJS (`require`) and ESM (`import`)
Expand Down
7 changes: 5 additions & 2 deletions obj/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
![jetstream](https://github.com/nats-io/nats.js/actions/workflows/obj.yml/badge.svg)
[![JSDoc](https://img.shields.io/badge/JSDoc-reference-blue)](https://nats-io.github.io/nats.js/obj/index.html)

[![JSR](https://jsr.io/badges/@nats-io/kv)](https://jsr.io/@nats-io/obj)
[![JSR](https://jsr.io/badges/@nats-io/kv/score)](https://jsr.io/@nats-io/obj)
[![JSR](https://jsr.io/badges/@nats-io/obj)](https://jsr.io/@nats-io/obj)
[![JSR](https://jsr.io/badges/@nats-io/obj/score)](https://jsr.io/@nats-io/obj)

[![NPM Version](https://img.shields.io/npm/v/%40nats-io%2Fobj)](https://www.npmjs.com/package/@nats-io/obj)
![NPM Downloads](https://img.shields.io/npm/dt/%40nats-io%2Fobj)
Expand All @@ -19,6 +19,9 @@ familiar to many application developers.

## Installation

For a quick overview of the libraries and how to install them, see
[runtimes.md](../runtimes.md).

Note that this library is distributed in two different registries:

- npm a node-specific library supporting CJS (`require`) and ESM (`import`)
Expand Down
7 changes: 5 additions & 2 deletions services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@
![jetstream](https://github.com/nats-io/nats.js/actions/workflows/services.yml/badge.svg)
[![JSDoc](https://img.shields.io/badge/JSDoc-reference-blue)](https://nats-io.github.io/nats.js/services/index.html)

[![JSR](https://jsr.io/badges/@nats-io/kv)](https://jsr.io/@nats-io/services)
[![JSR](https://jsr.io/badges/@nats-io/kv/score)](https://jsr.io/@nats-io/services)
[![JSR](https://jsr.io/badges/@nats-io/services)](https://jsr.io/@nats-io/services)
[![JSR](https://jsr.io/badges/@nats-io/services/score)](https://jsr.io/@nats-io/services)

[![NPM Version](https://img.shields.io/npm/v/%40nats-io%2Fservices)](https://www.npmjs.com/package/@nats-io/services)
![NPM Downloads](https://img.shields.io/npm/dt/%40nats-io%2Fservices)
![NPM Downloads](https://img.shields.io/npm/dm/%40nats-io%2Fservices)

# Services

For a quick overview of the libraries and how to install them, see
[runtimes.md](../runtimes.md).

The Services module introduces a higher-level API for implementing services with
NATS. NATS has always been a strong technology on which to build services, as
they are easy to write, are location and DNS independent and can be scaled up or
Expand Down