diff --git a/web/README.md b/web/README.md index 9bb1c37..9b222e3 100644 --- a/web/README.md +++ b/web/README.md @@ -1,11 +1,29 @@ ## Core -These 3 script should cannot be used independently and must all be present to work +These 3 scripts cannot be used independently and must all be present to work, they are mostly enhancing the frontend of python nodes - `comfy_shared`: library of methods used in `mtb_widgets` and `debug` +**mtb_widgets** define ui callbacks, and various widgets like the `COLOR` type: + + +or the `BOOL` type: + + +There is also `Debug` which is a node that should be able to display any data input, it handle a few cases and fallback to the string representation of the +data otherwise: +![debug](https://github.com/melMass/comfy_mtb/assets/7041726/1f4393e4-1c3d-4807-9501-fe8888bfae25) + + + ## Standalone -These scripts can be taken and placed independently of `comfy_mtb` or any other files, mimicking what pythongosss did for their [Custom Scripts](https://github.com/pythongosssss/ComfyUI-Custom-Scripts/tree/main/js) +These scripts can be taken and placed independently of `comfy_mtb` or any other files, mimicking what pythongosss did for their + +- **imageFeed**: a fork of @pythongosssss ' s [image feed](https://github.com/pythongosssss/ComfyUI-Custom-Scripts/tree/main/js), it adds support for: a lightbox to see images bigger, a way to load the current session history (in case of a web page reload), and different icons, most of the work come from the original script. + -- **imageFeed**: a fork of pythongosssss's image feed, it adds support for: a lightbox to see images bigger, a way to load the current session history (in case of a web page reload), and different icons, most of the work come from the original script. +> **NOTE** +> +> The original imagefeed got updated since and offer more options, ideally I would clean my lightbox thing and PR it to pythongoss later but in the meantime the script will detect if you already use the original one and not load this fork + - ![imagefeed](https://github.com/melMass/comfy_mtb/assets/7041726/c3acab4b-d28b-4432-a31b-248391aa2ee8) - **notify**: a basic toast notification system that I use in some places accross mtb, it can be used by simply calling `window.MTB.notify("Hello world!")`