From 05d1adc1796fd69ac0ff255869b10e9fc01ca271 Mon Sep 17 00:00:00 2001 From: "dayuan.jiang" Date: Mon, 24 Mar 2025 01:02:09 +0000 Subject: [PATCH] docs: update diagram representation library in README --- README.md | 38 ++++++-------------------------------- 1 file changed, 6 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 41bf2ab..e9a9e89 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The application uses the following technologies: - **Next.js**: For the frontend framework and routing - **@ai-sdk/react**: For the chat interface and AI interactions -- **draw.io XML**: For diagram representation and manipulation +- **react-drawio**: For diagram representation and manipulation Diagrams are represented as XML that can be rendered in draw.io. The AI processes your commands and generates or modifies this XML accordingly. @@ -58,31 +58,14 @@ npm run dev 5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the application. -## Usage +## Deployment -### Creating a New Diagram +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new) from the creators of Next.js. -Use the chat interface to describe the diagram you want to create: +Check out the [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. -``` -Create a flowchart showing the user authentication process with login, validation, and dashboard access steps. -``` - -### Modifying an Existing Diagram - -With an existing diagram open, use natural language to make changes: - -``` -Add a decision node after the validation step that redirects failed attempts to a retry page. -``` - -### Using Image References - -Upload an image as a reference by clicking the attachment button in the chat interface. Then ask the AI to use it as inspiration: - -``` -Create a similar flowchart to this image but add two more steps at the end. -``` +Or you can deploy by this button. +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDayuanJiang%2Fnext-ai-draw-io) ## Project Structure @@ -108,13 +91,4 @@ For support or inquiries, please open an issue on the GitHub repository or conta - Email: me[at]jiang.jp -## Deployment - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new) from the creators of Next.js. - -Check out the [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. - -Or you can deploy by this button. -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FDayuanJiang%2Fnext-ai-draw-io) - ---