WIP new readme

README-UPDATED.md

@@ -0,0 +1,118 @@
+# Serverless Redis HTTP (SRH)
+
+A Redis proxy and connection pooler that uses HTTP rather than the Redis binary protocol.\
+The aim of this project is to be entirely compatible with Upstash, and work with any Upstash supported Redis version.
+
+Use cases for SRH:
+- For usage in your CI pipelines, creating Upstash databases is tedious, or you have lots of parallel runs.
+    - See Using in GitHub Actions on how to quickly get SRH setup for this context.
+- For usage inside of Kubernetes, or any network whereby the Redis server is not exposed to the internet.
+    - See Using in Docker Compose for the various setup options directly using the Docker Container.
+- For local development environments, where you have a local Redis server running, or require offline access.
+    - See Using the Docker Command, or Using Docker Compose.
+
+## Differences between Upstash and Redis to note
+SRH tests are ran nightly against the `@upstash/redis` JavaScript package. However, there are some minor differences between Upstash's implementation of Redis and the official Redis code.
+
+- The `UNLINK` command will not throw an error when 0 keys are given to it. In Redis, and as such SRH, an error will be thrown.
+- In the `ZRANGE` command, in Upstash you are not required to provide `BYSCORE` or `BYLEX` in order to use the `LIMIT` argument. With Redis/SRH, this will throw an error if not provided.
+- The Upstash implementation of `RedisJSON` contains a number of subtle differences in what is returned in responses. For this reason, **it is not advisable to use SRH with Redis Stack if you are testing your Upstash implementation that uses JSON commands**. If you don't use any JSON commands, then all is good :)
+- **SRH does not implement commands via paths, or accepting the token via a query param**. Only the body method is implemented, which the `@upstash/redis` SDK implements.
+
+### Similarities to note:
+
+Pipelines and Transaction endpoints are also implemented, also using the body data only. You can read more about the RestAPI here: [Upstash Docs on the Rest API](https://docs.upstash.com/redis/features/restapi)
+
+Response encoding is also fully implemented. This is enabled by default by the `@upstash/redis` SDK. You can read more about that here: [Upstash Docs on Hashed Responses](https://docs.upstash.com/redis/sdks/javascriptsdk/troubleshooting#hashed-response)
+
+## How to use with the `@upstash/redis` SDK
+Simply set the REST URL and token to where the SRH instance is running. For example:
+```ts
+import {Redis} from '@upstash/redis';
+
+export const redis = new Redis({
+    url: "http://localhost:8079",
+    token: "example_token",
+});
+```
+
+# Setting up SRH
+## Via Docker command
+If you have a locally running Redis server, you can simply start an SRH container that connects to it.
+In this example, SRH will be running on port `8080`.
+
+```bash
+docker run \
+    -it -d -p 8080:80 --name srh \
+    -e SRH_MODE=env \
+    -e SRH_TOKEN=your_token_here \
+    -e SRH_CONNECTION_STRING="redis://your_server_here:6379" \
+    hiett/serverless-redis-http:latest
+```
+
+## Via Docker Compose
+If you wish to run in Kubernetes, this should contain all the basics would need to set that up. However, be sure to read the Configuration Options, because you can create a setup whereby multiple Redis servers are proxied.
+```yml
+version: '3'
+services:
+  redis:
+    image: redis
+    ports:
+      - '6379:6379'
+  serverless-redis-http:
+    ports:
+      - '8079:80'
+    image: hiett/serverless-redis-http:latest
+    environment:
+      SRH_MODE: env
+      SRH_TOKEN: example_token
+      SRH_CONNECTION_STRING: 'redis://redis:6379' # Using `redis` hostname since they're in the same Docker network.
+```
+
+## In GitHub Actions
+
+SRH works nicely in GitHub actions because you can run it as a container in a job's services. Simply start a Redis server, and then
+SRH alongside it. You don't need to worry about a race condition of the Redis instance not being ready, because SRH doesn't create a Redis connection until the first command comes in.
+
+```yml
+name: Test @upstash/redis compatability
+on:
+  push:
+  workflow_dispatch:
+
+env:
+  SRH_TOKEN: example_token
+
+jobs:
+  container-job:
+    runs-on: ubuntu-latest
+    container: denoland/deno
+    services:
+      redis:
+        image: redis/redis-stack-server:6.2.6-v6 # 6.2 is the Upstash compatible Redis version
+      srh:
+        image: hiett/serverless-redis-http:latest
+        env:
+          SRH_MODE: env # We are using env mode because we are only connecting to one server.
+          SRH_TOKEN: ${{ env.SRH_TOKEN }}
+          SRH_CONNECTION_STRING: redis://redis:6379
+
+    steps:
+      # You can place your normal testing steps here. In this example, we are running SRH against the upstash/upstash-redis test suite.
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          repository: upstash/upstash-redis
+
+      - name: Run @upstash/redis Test Suite
+        run: deno test -A ./pkg
+        env:
+          UPSTASH_REDIS_REST_URL: http://srh:80
+          UPSTASH_REDIS_REST_TOKEN: ${{ env.SRH_TOKEN }}
+```
+
+# Configuration Options
+
+## Connecting to multiple Redis servers at the same time
+
+## Environment Variables