From 86d8265f839e90d49e87b285da86609811fa84cd Mon Sep 17 00:00:00 2001
From: Paul <fofr@users.noreply.github.com>
Date: Fri, 28 Jun 2024 12:24:16 +0000
Subject: [PATCH] Add a README

---
 README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 64 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index aee12ac..440adcf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,64 @@
-# comfyui-replicate
\ No newline at end of file
+# comfyui-replicate
+
+Custom nodes for running [Replicate models](https://replicate.com/explore) in ComfyUI.
+
+Take a look at the example workflows to get started.
+
+## Set your Replicate API token before running
+
+Make sure you set your REPLICATE_API_TOKEN in your environment. Get your API tokens here, we recommend creating a new one:
+
+https://replicate.com/account/api-tokens
+
+To pass in your API token when running ComfyUI you could do:
+
+On MacOS or Linux:
+
+```sh
+export REPLICATE_API_TOKEN="r8_************"; python main.py
+```
+
+On Windows:
+
+```sh
+set REPLICATE_API_TOKEN="r8_************"; python main.py
+```
+
+## Direct installation
+
+```sh
+cd ComfyUI/custom-nodes
+git clone https://github.com/fofr/comfyui-replicate
+cd comfyui-replicate
+pip install -r requirements.txt
+```
+
+## Supported Replicate models
+
+View the `supported_models.json` to see which models are packaged by default.
+
+## Update Replicate models
+
+Simply run `./import_schemas.py` to update all model nodes. The latest version of a model is used by default.
+
+## Add more models
+
+Only models that return simple text or image outputs are currently supported. If a model returns audio, video, JSON objects or a combination of outputs, the node will not work as expected.
+
+If you want to add more models, you can:
+
+- add the model to `supported_models.json` (for example, `fofr/consistent-character`)
+- run `./import_schemas.py`, this will update all schemas and import your new model
+- restart ComfyUI
+- use the model in workflow, it’ll have the title ‘Replicate [model author/model name]’
+
+## Roadmap
+
+Things to investigate and add to this custom node package:
+
+- support for more types of Replicate model (audio and video first)
+- showing logs, prediction status and progress (via tqdm)
+
+## Contributing
+
+If you add models that others would find useful, feel free to raise PRs.