From 4972fdbfa1d8636eb7ddb47a1f6142733ca3d329 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=CC=A7ag=CC=86an=20Kiraz?= <kiraz@gmx.com>
Date: Sat, 5 Oct 2024 19:12:06 +0300
Subject: [PATCH] add: README.md

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..aa50dc9
--- /dev/null
+++ b/README.md
@@ -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)