@upstash/redis 1.6.1-next.1 → 1.6.1

package/README.md

@@ -11,9 +11,9 @@ It is the only connectionless (HTTP based) Redis client and designed for:
 
 - Serverless functions (AWS Lambda ...)
 - Cloudflare Workers (see
-  [the example](https://github.com/upstash/upstash-redis/tree/master/examples/cloudflare-workers))
+  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers))
 - Fastly Compute@Edge (see
-  [the example](https://github.com/upstash/upstash-redis/tree/master/examples/fastly))
+  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/fastly))
 - Next.js, Jamstack ...
 - Client side web/mobile applications
 - WebAssembly
@@ -23,11 +23,86 @@ See
 [the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility)
 supported.
 
+## Quick Start
+
+### Install
+
+#### npm
+
+```bash
+npm install @upstash/redis
+```
+
+#### Deno
+
+```ts
+import { Redis } from "https://deno.land/x/upstash_redis/mod.ts";
+```
+
+### Create database
+
+Create a new redis database on [upstash](https://console.upstash.com/)
+
+## Basic Usage:
+
+```ts
+import { Redis } from "@upstash/redis"
+
+const redis = new Redis({
+  url: <UPSTASH_REDIS_REST_URL>,
+  token: <UPSTASH_REDIS_REST_TOKEN>,
+})
+
+// string
+await redis.set('key', 'value');
+let data = await redis.get('key');
+console.log(data)
+
+await redis.set('key2', 'value2', {ex: 1});
+
+// sorted set
+await redis.zadd('scores', { score: 1, member: 'team1' })
+data = await redis.zrange('scores', 0, 100 )
+console.log(data)
+
+// list
+await redis.lpush('elements', 'magnesium')
+data = await redis.lrange('elements', 0, 100 )
+console.log(data)
+
+// hash
+await redis.hset('people', {name: 'joe'})
+data = await redis.hget('people', 'name' )
+console.log(data)
+
+// sets
+await redis.sadd('animals', 'cat')
+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?
+
+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).
+
 ## Docs
 
-See
-[the documentation](https://docs.upstash.com/redis/sdks/javascriptsdk/getstarted)
-for details.
+See [the documentation](https://docs.upstash.com/features/javascriptsdk) for
+details.
 
 ## Contributing
 

package/package.json

@@ -3,6 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
+  "version": "v1.6.1",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",
@@ -96,6 +97,5 @@
       "require": "./script/platforms/node_with_fetch.js",
       "types": "./types/platforms/node_with_fetch.d.ts"
     }
-  },
-  "version": "1.6.1-next.1"
+  }
 }