/proxy endpoint and some docs

README.md

@@ -1 +1,28 @@
 # fake-sanity-image-cdn
+
+## What is it?
+
+A proxy to use Sanity <code>@sanity/image-url</code> helper with
+fake image. Usefull in tests or storybook.
+
+## How to use it?
+
+Use this proxy service as the `baseUrl` when you create the
+imageUrlBuilder instanse:
+
+```js
+import imageUrlBuilder from '@sanity/image-url';
+
+const myConfiguredSanityClient = {
+/_ ... _/,
+baseUrl: "https://fake-sanity-image-cdn.vercel.app/proxy/"
+};
+
+const builder = imageUrlBuilder(myConfiguredSanityClient);
+
+console.log(builder.image("...").url())</code></pre>
+```
+
+## Limitations
+
+- Do not support `webp` image transformations (`jpg` image will alwails be returned)

api/proxy.js

@@ -1,6 +1,5 @@
 const EXTRACT_INFO_FROM_PATH_REGEX = /([a-zA-Z0-9]+)-([0-9]+)x([0-9]+)\.([a-z]+)$/i;
 
-// TODO: Rename endpoint to `/api/sanity-endpoint`
 // TODO: Extract width and height from the query to overload the one in the path
 // TODO: Extract the format from the query to validate it (picsum.photos only support jpg)
 export default (req, res) => {

vercel.json

@@ -1,3 +1,10 @@
 {
-  "rewrites": [{ "source": "/bar(/.*)", "destination": "/api/proxy?path=$1" }]
+  "redirects": [
+    {
+      "source": "/",
+      "statusCode": 301,
+      "destination": "https://github.com/gogaille/fake-sanity-image-cdn"
+    }
+  ],
+  "rewrites": [{ "source": "/proxy(/.*)", "destination": "/api/proxy?path=$1" }]
 }