diff --git a/README.md b/README.md index 7b3be49..61093f2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# screenshot-to-html +# screenshot-to-code -This is a simple app that converts a screenshot to HTML (uses Tailwind CSS). It uses GPT-4 Vision to generate the code. +This is a simple app that converts a screenshot to HTML/Tailwind CSS. It uses GPT-4 Vision to generate the code. [Video GIF] ## Getting Started -The app has a React/Vite front-end and a FastAPI backend. You will need an OpenAI API key with access to the GPT-4 Vision API. +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. In the root directory, @@ -23,8 +23,8 @@ yarn dev Open http://localhost:5173 to use the app. -If you prefer to run the backend on a different port, just modify VITE_WS_BACKEND_URL=ws://127.0.0.1:7000 in .env.local. +If you prefer to run the backend on a different port, update VITE_WS_BACKEND_URL in `frontend/.env.local` ## Hosted Version -Hosted version coming soon at https://picoapps.xyz +Hosted version coming soon at http://makewithpico.com