Skip to content

Commit 29922a6

Browse files
committed
fixed service examples and readmes
1 parent 93e546b commit 29922a6

File tree

2 files changed

+20
-18
lines changed

2 files changed

+20
-18
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ This repository hosts native runtime support ("transports") for:
1616

1717
A big change with the v3 clients is that the "nats-base-client" which implements
1818
all the runtime agnostic functionality of the clients, is now split into several
19-
modules. This split simplify the initial user experience as well as the
20-
development and evolution of the current functionality.
19+
modules. This split simplifies the initial user experience as well as the
20+
development and evolution of the JavaScript clients and new functionality.
2121

2222
The new modules are:
2323

@@ -29,22 +29,23 @@ The new modules are:
2929
- [Services](obj/README.md) which implements a framework for building NATS
3030
services
3131

32-
If you are getting started with NATS for the first time, we now have the
33-
opportunity to have a simplified on-boarding experience that allows you to go
34-
into one of our NATS technologies. Perhaps you heard about the NATS KV and would
35-
like to incorporate it into your app. The KV module will shortcut a lot of
36-
things for you. You will of course need a transport which will connect you to a
37-
NATS server, but once you know how to create a connection you will be focusing
38-
on a smaller subset of the APIs. From there, we are certain that you will
39-
broaden your use of NATS into other areas.
32+
If you are getting started with NATS for the first time, you'll be able to pick
33+
one of our technologies and more easily incorporate it into your apps. Perhaps
34+
you heard about the NATS KV and would like to incorporate it into your app. The
35+
KV module will shortcut a lot of things for you. You will of course need a
36+
transport which will allow you to `connect` you to a NATS server, but once you
37+
know how to create a connection you will be focusing on a smaller subset of the
38+
APIs rather than be confronted with all the functionality you can use in a NATS
39+
client. From there, we are certain that you will broaden your use of NATS into
40+
other areas, but your initial effort should be more straight forward.
4041

4142
Another reason for the change is that it has the potential to make your client a
4243
bit smaller, and if versions change on a submodule that you don't use, you won't
43-
be confronted with an upgrade choice. It also allows us to version more
44-
strictly, and thus telegraph to you the effort or scope of changes and prevent
45-
surprises when upgrading.
44+
be confronted with an upgrade choice. These modules also allows us to version
45+
more strictly, and thus telegraph to you the effort or scope of changes and
46+
prevent surprises when upgrading.
4647

47-
The decoupling of the NATS client functionality from a transport, also enables
48+
By decoupling of the NATS client functionality from a transport, we enable NATS
4849
developers to create new modules that can run all runtimes so long as they
4950
follow a pattern where a `NatsConnection` (or some other standard interface) is
5051
used as the basis of the module. For example, the JetStream module exposes a

core/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# NATS Core
1+
# Core
22

33
The _core_ module implements the _core_ functionality for JavaScript clients:
44

55
- Connection, authentication, connection lifecycle
66
- NATS protocol handling - messaging functionality (publish, subscribe and
77
request reply)
88

9-
A native transports (node, deno, browser) module exports a `connect` function
10-
that returns a concrete instance of a `NatsConnection` which exports all the
11-
functionality in this module.
9+
A native transports (node, deno, browser) modules are a peer module that export
10+
a `connect` function which returns a concrete instance of a `NatsConnection`.
11+
The transport library re-exports all the functionality in this module, to make
12+
it the entry point into the NATS JavaScript ecosystem.
1213

1314
You can use this module as a runtime agnostic dependency and implement
1415
functionality that uses a NATS client connection without binding your code to a

0 commit comments

Comments
 (0)