Updated readme.md

2024-06-03 21:36:37 +08:00
parent 7ee79914a1
commit da41ec04ef
1 changed files with 41 additions and 1 deletions
@@ -1 +1,41 @@
-The purpose of this package is to understand how loading of diffusers format checkpoints are done in comfyUI and to create a loader that works for SDXL.
+# Diffusers Format Checkpoint Loaders for ComfyUI
+
+This project aims to create loaders for diffusers format checkpoint models, making it easier for ComfyUI users to use diffusers format checkpoints instead of the standard ones.
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Features](#features)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+## Introduction
+
+This project provides tools and loaders for integrating diffusers format checkpoint models with ComfyUI. It helps users who already have diffusers format checkpoints to seamlessly use them without needing to convert them to the standard format.
+
+## Installation
+
+Follow these steps to install and set up the project:
+
+```bash
+# Clone the repository
+git clone https://github.com/Scorpinaus/ComfyUI-DiffusersLoader.git
+
+# Navigate to the project directory
+cd diffusers-checkpoint-loaders
+
+#Access comfyUI
+
+## Contributing
+Contributions are always welcome! Please follow the contributing guidelines to submit issues or pull requests.
+
+## License
+This project is licensed under the MIT License.
+
+## Contact
+
+Hafiz Saffie - hafiz.safs@gmail.com
+Project Link: https://github.com/Scorpinaus/ComfyUI-DiffusersLoader