Merge pull request #5 from team-plain/p-7887-update-readme

Update readme

Author: DLeyland

README.md

@@ -1,36 +1,39 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# Plain headless portal
 
-## Getting Started
+This is a minimally styled example [Next.js](https://nextjs.org/) project demonstrating how you can use the Plain API to create a custom support portal. In the portal your customers can log in to:
 
-First, run the development server:
+- Raise new support requests
+- View requests raised by anyone in their tenant
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+## Getting Started
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+In order to use this example you first need to have a workspace set up with [Plain](https://www.plain.com/) on at least the [Grow plan](https://www.plain.com/pricing).
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+Now you will need to create an API key for the support portal backend to authenticate with Plain.
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+- Log in to Plain and go to `Settings -> Machine users`
+- Click `Add machine user` and fill in the details
+- You should be taken to your machine user, now click `Add API key`
+- Copy the permissions from below and click 'Paste permissions'
+- Fill in the description and save the key
 
-## Learn More
+```
+attachment:download,company:read,customer:read,customerGroup:read,customerGroupMembership:read,customerTenantMembership:read,email:read,label:read,labelType:read,note:read,roles:read,serviceLevelAgreement:read,tenant:read,tenant:search,thread:read,tier:read,tierMembership:read,timeline:read,user:read,workspace:read,threadField:read,threadFieldSchema:read,customer:create,customer:edit,thread:create,thread:edit
+```
 
-To learn more about Next.js, take a look at the following resources:
+Once you have your key you can get started:
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+```bash
+npm install
+PLAIN_API_KEY=<your_key> npm run dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+## Screenshots
 
-## Deploy on Vercel
+ ![View the list of requests](/screenshots/thread-list.png)
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+ ![See the details of a support request](/screenshots/thread-page.png)
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+ ![Create a new support request](/screenshots/new-request.png)