diff --git a/README.md b/README.md index 49fcd2d..2376f72 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Screenshot-to-Code: Transform Screenshots into HTML & Tailwind CSS +# screenshot-to-code -Welcome to Screenshot-to-Code, an innovative application that seamlessly converts screenshots into HTML and Tailwind CSS code. Powered by the cutting-edge GPT-4 Vision and DALL-E 3 technologies, this tool is your go-to solution for rapid web development and design. +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 @@ -12,10 +12,9 @@ See [Examples](#examples) section below for more demos. ## 🌟 Recent 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. - +- 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 @@ -45,16 +44,16 @@ If you prefer to run the backend on a different port, update VITE_WS_BACKEND_URL ## 🙋‍♂️ 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_). +- **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 | 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)**