From 041f2937683772b56f44ba979805a807c0a54b9c Mon Sep 17 00:00:00 2001
From: DaEpic <107145976+DaEpicR@users.noreply.github.com>
Date: Sat, 18 Nov 2023 07:45:41 +0100
Subject: [PATCH] Revert "Update README.md"

This reverts commit 339d40ef2251ab4f64fa183a352ac323ab8e9f3d.
---
 README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 68 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 8434608..0359a1d 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,68 @@
-## ToDO :
-Review Code for possible improvements . <---- in progress 
-Adding feutures (no idea how , but i will try to) <-------- not yet
-Checking for security flaws <----------- after a few weeks after the project get more commits .
+# screenshot-to-code
+
+This is a simple app that converts a screenshot to HTML/Tailwind CSS. It uses GPT-4 Vision to generate the code, and DALL-E 3 to generate similar looking images.
+
+https://github.com/abi/screenshot-to-code/assets/23818/6cebadae-2fe3-4986-ac6a-8fb9db030045
+
+See Examples section below for more demos.
+
+🆕 [Try it here](https://picoapps.xyz/free-tools/screenshot-to-code) (bring your own OpenAI key - **your key must have access to GPT-4 Vision. See FAQ section below for details**). Or see Getting Started below for local install instructions.
+
+## Updates
+
+* Nov 16 - Added a setting to disable DALL-E image generation if you don't need that
+* Nov 16 - View code directly within the app
+* Nov 15 - 🔥 You can now instruct the AI to update the code as you wish. Useful if the AI messed up some styles or missed a section.
+
+
+## Getting Started
+
+The app has a React/Vite frontend and a FastAPI backend. You will need an OpenAI API key with access to the GPT-4 Vision API.
+
+Run the backend (I use Poetry for package management - `pip install poetry` if you don't have it):
+
+```bash
+cd backend
+echo "OPENAI_API_KEY=sk-your-key" > .env
+poetry install
+poetry shell
+poetry run uvicorn main:app --reload --port 7000
+```
+
+Run the frontend:
+
+```bash
+cd frontend
+yarn
+yarn dev
+```
+
+Open http://localhost:5173 to use the app.
+
+If you prefer to run the backend on a different port, update VITE_WS_BACKEND_URL in `frontend/.env.local`
+
+## FAQs
+
+* **I'm running into an error when setting up the backend. How can I fix it?** [Try this](https://github.com/abi/screenshot-to-code/issues/3#issuecomment-1814777959). If that still doesn't work, open an issue.
+* **How do I get an OpenAI API key that has the GPT4 Vision model available?** Create an OpenAI account. And then, you need to buy at least $1 worth of credit on the [Billing dashboard](https://platform.openai.com/account/billing/overview).
+* **How can I provide feedback?** For feedback, feature requests and bug reports, open an issue or ping me on [Twitter](https://twitter.com/_abi_). 
+
+## Examples
+
+**NYTimes**
+
+| Original | Replica |
+|----------|---------|
+| ![Original](https://github.com/abi/screenshot-to-code/assets/23818/01b062c2-f39a-46dd-84ca-bec6c986463a) | ![Replica](https://github.com/abi/screenshot-to-code/assets/23818/e1f662b6-68f7-4578-a64d-ea4be52e31f5) |
+
+**Instagram page (with not Taylor Swift pics)**
+
+https://github.com/abi/screenshot-to-code/assets/23818/503eb86a-356e-4dfc-926a-dabdb1ac7ba1
+
+**Hacker News** but it gets the colors wrong at first so we nudge it
+
+https://github.com/abi/screenshot-to-code/assets/23818/3fec0f77-44e8-4fb3-a769-ac7410315e5d
+
+## Hosted Version
+
+🆕 [Try it here](https://picoapps.xyz/free-tools/screenshot-to-code) (bring your own OpenAI key - **your key must have access to GPT-4 Vision. See FAQ section below for details**). Or see Getting Started below for local install instructions.