diff --git a/README.md b/README.md index 61a9ea9..f720300 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ # ComfyUI-Dashscope -This project adapts the dashscope([aliyun-bailian](https://bailian.console.aliyun.com)) api into ComfyUI. +This project integrates the Dashscope API from [Aliyun Bailian](https://bailian.console.aliyun.com) into ComfyUI. + +![vlm example](assets/vlm.png) +Refer to this example workflow for a quick start. ## Requirements +### Environment Setup + +Set the system environment variable `DASHSCOPE_API_KEY` on your computer. Refer to [this guide](https://help.aliyun.com/zh/model-studio/developer-reference/configure-api-key-through-environment-variables?spm=a2c4g.11186623.help-menu-2400256.d_3_1.3f8a1078V8zfae&scm=20140722.H_2803795._.OR_help-T_cn~zh-V_1#e4cd73d544i3r) for instructions on configuring the Dashscope API key based on your system. You can view your API key [here](https://bailian.console.aliyun.com/?apiKey=1#/api-key). + +### Installation + Install the necessary Python dependencies with: ```sh @@ -12,8 +21,11 @@ pip install -r requirements.txt ## Models -You can find LLM models or other AI models in [models](./models.md). +You can find LLM models or other AI models in [models documentation](./models.md). -### Contribution +## Contribution -Thank you for considering contributions! Fork the repository, make changes, and send a pull request for review and merging. +We welcome contributions! Please fork the repository, make your changes, and submit a pull request for review. + +## License +This project is licensed under the MIT License. See the LICENSE file for details. diff --git a/assets/vlm.png b/assets/vlm.png new file mode 100644 index 0000000..886ea87 Binary files /dev/null and b/assets/vlm.png differ