From c5f82d9294384e3a4963edb79e5f80ce02da3d66 Mon Sep 17 00:00:00 2001
From: tarjelavik <Tarje.Lavik@ub.uib.no>
Date: Tue, 8 Mar 2022 15:25:08 +0100
Subject: [PATCH] Update README
---
README.md | 35 +++++++++++++++++++++++++----------
1 file changed, 25 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 4724506..44c47c3 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,16 @@
# Nansen Exhibition
-Universitetsbiblioteket i Bergens repositorium for Sanity.io redigeringsklient og Next.js frontend. Nansen utstillingen er et samarbeid mellom biblioteket og prosjektet [Arven etter Nansen](https://arvenetternansen.com/). Utstillingen ble laget i perioden 2020-21.
+Repository for the University of Bergen Library web exhibition "Nansen og bergenserne" (Nansen and the people of Bergen"). It includes a Sanity Studio editor and a Next.js frontend.
-## Documentation
-
-See [the docs](./docs/README.md)
+The exhibition was a cooperation between the library and the project [Arven etter Nansen (The Nansen Legacy)](https://arvenetternansen.com/), created between 2020-21.
## Deployment
-BÃ¥de `studio` og `web` deployes til [Vercel.com](https://vercel.com/) via `git push`.
+Both `studio` and `web` is deployed by [Vercel.com](https://vercel.com/) via `git push`.
## Quick start
-This repository uses `yarn`!
+**NB!** This repository uses `yarn`!
1. Clone this repository
1. `yarn global add @sanity/cli`
@@ -24,7 +22,6 @@ This repository uses `yarn`!
- Your frontend should be running on [http://localhost:3000](http://localhost:3000)
4. `yarn run build` to build to production locally
-
## Environment variables and tokens
### Studio
@@ -42,11 +39,29 @@ SANITY_STUDIO_VERCEL_DEPLOY_HOOK=
SANITY_STUDIO_INSTAGRAM_TOKEN=
```
+### Web
+
+```yaml
+# Datalake
+NEXT_PUBLIC_SANITY_PROJECT_ID=
+NEXT_PUBLIC_SANITY_DATASET=production
+# Preview
+NEXT_PUBLIC_SANITY_API_TOKEN=
+NEXT_PUBLIC_SANITY_PREVIEW_SECRET=
+# For correct proxy path
+NEXT_PUBLIC_BASE_PATH=
+NEXT_PUBLIC_DOMAIN=
+# Extras
+NEXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
+NEXT_PUBLIC_INSTAGRAM_TOKEN=
+NEXT_PUBLIC_GOOGLE_ANALYTICS=
+```
+
#### Instagram
-In the studio you can embed Instagram posts, but you need a access token from Facebook. See https://www.npmjs.com/package/react-instagram-embed for details. Add the token to `.env.development` and as a enviroment variable on Vercel or Netlify.
+In the studio you can embed Instagram posts, but you need a access token from Facebook. See https://www.npmjs.com/package/react-instagram-embed for details. Add the token to `./web/.env.development` and as a enviroment variable on Vercel or Netlify.
+## Documentation
-## Stuck with Sanity? Get help
+General documentation see [the docs](./docs/README.md)
-[](https://slack.sanity.io/)
--
GitLab