add: README.md

2024-10-05 19:12:06 +03:00
parent 51e2b84bd6
commit 4972fdbfa1
1 changed files with 33 additions and 0 deletions
@@ -0,0 +1,33 @@
+# ComfyUI-FLUX-BFL-API
+Custom nodes for integrating Flux models with the BFL API.
+
+## Installation
+
+To get started with ComfyUI-FLUX-BFL-API, follow these steps:
+
+1. Clone the repository:
+    ```bash
+    cd custom_nodes
+    git clone https://github.com/gelasdev/ComfyUI-FLUX-BFL-API.git
+    ```
+
+2. Install the required dependencies:
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+3. Get your BFL API key from [api.bfl.ml](https://api.bfl.ml).
+
+4. Add your API key to the `config.ini` file:
+    ```ini
+    [API]
+    key = YOUR_API_KEY
+    ```
+
+## Usage
+
+After setting up, you can begin using the custom nodes with Flux models through the BFL API.
+
+## Example
+
+![image](https://github.com/user-attachments/assets/7cd71a76-68da-445a-83c2-878fd9c77320)