@upstash/redis 0.0.0-ci.fb6b986f-20221006 → 0.0.0-ci.fbead4fb2ed281bdc04ec90c263e6380eed1465b-20251021062126

package/README.md

@@ -7,6 +7,11 @@ of [Upstash REST API](https://docs.upstash.com/features/restapi).
 ![npm (scoped)](https://img.shields.io/npm/v/@upstash/redis)
 ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@upstash/redis)
 
+> [!NOTE]  
+> **This project is in GA Stage.**
+>
+> The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes. The Upstash team is committed to maintaining and improving its functionality.
+
 It is the only connectionless (HTTP based) Redis client and designed for:
 
 - Serverless functions (AWS Lambda ...)
@@ -20,14 +25,14 @@ It is the only connectionless (HTTP based) Redis client and designed for:
 - and other environments where HTTP is preferred over TCP.
 
 See
-[the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility)
+[the list of APIs](https://upstash.com/docs/redis/overall/rediscompatibility)
 supported.
 
 ## Quick Start
 
 ### Install
 
-#### npm
+#### Node.js
 
 ```bash
 npm install @upstash/redis
@@ -36,7 +41,7 @@ npm install @upstash/redis
 #### Deno
 
 ```ts
-import { Redis } from "https://deno.land/x/upstash_redis/mod.ts";
+import { Redis } from "https://esm.sh/@upstash/redis";
 ```
 
 ### Create database
@@ -58,7 +63,7 @@ await redis.set('key', 'value');
 let data = await redis.get('key');
 console.log(data)
 
-await redis.set('key2', 'value2', {ex: 1});
+await redis.set('key3', 'value3', {ex: 1});
 
 // sorted set
 await redis.zadd('scores', { score: 1, member: 'team1' })
@@ -81,32 +86,21 @@ data  = await redis.spop('animals', 1)
 console.log(data)
 ```
 
-### Upgrading to v1.4.0 **(ReferenceError: fetch is not defined)**
-
-If you are running on nodejs v17 and earlier, `fetch` will not be natively
-supported. Platforms like Vercel, Netlify, Deno, Fastly etc. provide a polyfill
-for you. But if you are running on bare node, you need to either specify a
-polyfill yourself or change the import path to:
-
-```typescript
-import { Redis } from "@upstash/redis/with-fetch";
-```
-
-### Upgrading from v0.2.0?
+## Troubleshooting
 
-Please read the
-[migration guide](https://docs.upstash.com/redis/sdks/javascriptsdk/migration).
-For further explanation we wrote a
-[blog post](https://blog.upstash.com/upstash-redis-sdk-v1).
+We have a
+[dedicated page](https://docs.upstash.com/redis/sdks/javascriptsdk/troubleshooting)
+for common problems. If you can't find a solution, please
+[open an issue](https://github.com/upstash/upstash-redis/issues/new).
 
 ## Docs
 
-See [the documentation](https://docs.upstash.com/features/javascriptsdk) for
+See [the documentation](https://upstash.com/docs/redis/sdks/ts/overview) for
 details.
 
 ## Contributing
 
-### [Install Deno](https://deno.land/#installation)
+### [Install Bun](https://bun.sh/docs/installation)
 
 ### Database
 
@@ -116,8 +110,36 @@ the url and token
 ### Running tests
 
 ```sh
-UPSTASH_REDIS_REST_URL=".." UPSTASH_REDIS_REST_TOKEN=".." deno test -A
+bun run test
+```
+
+### Building
+
+```sh
+bun run build
 ```
 
+### Telemetry
+
+This library sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Deno, Cloudflare, Vercel)
+- Runtime version (node@18.x)
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value.
+
+```sh
+UPSTASH_DISABLE_TELEMETRY=1
 ```
+
+Alternatively, you can pass `enableTelemetry: false` when initializing the Redis client:
+
+```ts
+const redis = new Redis({
+  // ...,
+  enableTelemetry: false,
+});
 ```