@upstash/qstash 0.1.6 → 0.1.8

package/README.md

@@ -1,10 +1,8 @@
-# Upstash qStash SDK
+# Upstash QStash SDK
 
-[![Tests](https://github.com/upstash/sdk-qstash-ts/actions/workflows/tests.yaml/badge.svg)](https://github.com/upstash/sdk-qstash-ts/actions/workflows/tests.yaml)
-![npm (scoped)](https://img.shields.io/npm/v/@upstash/redis)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/@upstash/redis)
+![npm (scoped)](https://img.shields.io/npm/v/@upstash/qstash)
 
-**qStash** is an HTTP based messaging and scheduling solution for serverless and
+**QStash** is an HTTP based messaging and scheduling solution for serverless and
 edge runtimes.
 
 It is 100% built on stateless HTTP requests and designed for:
@@ -19,10 +17,6 @@ It is 100% built on stateless HTTP requests and designed for:
 - WebAssembly
 - and other environments where HTTP is preferred over TCP.
 
-See
-[the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility)
-supported.
-
 ## Status of the SDK
 
 It is currently in beta and we are actively collecting feedback from the
@@ -30,11 +24,11 @@ community. Please report any issues you encounter or feature requests in the
 [GitHub issues](https://github.com/upstash/sdk-qstash-ts/issues) or talk to us
 on [Discord](https://discord.gg/w9SenAtbme). Thank you!
 
-## How does qStash work?
+## How does QStash work?
 
-qStash is the message broker between your serverless apps. You send aa HTTP
-request to qStash, that includes a destination, a payload and optional settings.
-We store your message durable and will deliver it to the destination API via
+QStash is the message broker between your serverless apps. You send an HTTP
+request to QStash, that includes a destination, a payload and optional settings.
+We durably store your message and will deliver it to the destination API via
 HTTP. In case the destination is not ready to receive the message, we will retry
 the message later, to guarentee at-least-once delivery.
 
@@ -75,7 +69,8 @@ const c = new Client({
 });
 
 const res = await c.publishJSON({
-  destination: "https://my-api...",
+  url: "https://my-api...",
+  // or topic: "the name or id of a topic"
   body: {
     hello: "world",
   },