diff --git a/README.md b/README.md index 6ae2667..ee91353 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,14 @@ # ComfyUI-LoadImageWithFileName -Load Image With FileName - -> [!NOTE] -> This projected was created with a [cookiecutter](https://github.com/Comfy-Org/cookiecutter-comfy-extension) template. It helps you start writing custom nodes without worrying about the Python setup. - -## Quickstart - -1. Install [ComfyUI](https://docs.comfy.org/get_started). -1. Install [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) -1. Look up this extension in ComfyUI-Manager. If you are installing manually, clone this repository under `ComfyUI/custom_nodes`. -1. Restart ComfyUI. +Load Image With FileName, Path # Features +![ex_screenshot](./img/example.png) +- You can load image with file name, path. -- A list of features - -## Develop - -To install the dev dependencies and pre-commit (will run the ruff hook), do: - -```bash -cd ComfyUI_LoadImageWithFileName -pip install -e .[dev] -pre-commit install -``` - -The `-e` flag above will result in a "live" install, in the sense that any changes you make to your node extension will automatically be picked up the next time you run ComfyUI. - -## Publish to Github - -Install Github Desktop or follow these [instructions](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for ssh. - -1. Create a Github repository that matches the directory name. -2. Push the files to Git -``` -git add . -git commit -m "project scaffolding" -git push -``` - -## Writing custom nodes - -An example custom node is located in [node.py](src/ComfyUI_LoadImageWithFileName/nodes.py). To learn more, read the [docs](https://docs.comfy.org/essentials/custom_node_overview). - - -## Tests - -This repo contains unit tests written in Pytest in the `tests/` directory. It is recommended to unit test your custom node. - -- [build-pipeline.yml](.github/workflows/build-pipeline.yml) will run pytest and linter on any open PRs -- [validate.yml](.github/workflows/validate.yml) will run [node-diff](https://github.com/Comfy-Org/node-diff) to check for breaking changes - -## Publishing to Registry - -If you wish to share this custom node with others in the community, you can publish it to the registry. We've already auto-populated some fields in `pyproject.toml` under `tool.comfy`, but please double-check that they are correct. - -You need to make an account on https://registry.comfy.org and create an API key token. - -- [ ] Go to the [registry](https://registry.comfy.org). Login and create a publisher id (everything after the `@` sign on your registry profile). -- [ ] Add the publisher id into the pyproject.toml file. -- [ ] Create an api key on the Registry for publishing from Github. [Instructions](https://docs.comfy.org/registry/publishing#create-an-api-key-for-publishing). -- [ ] Add it to your Github Repository Secrets as `REGISTRY_ACCESS_TOKEN`. - -A Github action will run on every git push. You can also run the Github action manually. Full instructions [here](https://docs.comfy.org/registry/publishing). Join our [discord](https://discord.com/invite/comfyorg) if you have any questions! - +# Installation +1. Navigate to your ComfyUI installation directory. +2. Go to the custom_nodes folder. +3. Clone this repository. +```git clone https://github.com/HAEGONG/ComfyUI_LoadImageWithFileName.git``` +4. Restart ComfyUI. \ No newline at end of file diff --git a/img/example.png b/img/example.png new file mode 100644 index 0000000..97a4ffe Binary files /dev/null and b/img/example.png differ