update readme (#3)

- add readme to match the other flux model (ebf52e2feab7713b4338719de54d145c4b3c4236)
- update model_version and add note (9a7ac868f3e2533f21875c90200671b03e34caff)


Co-authored-by: Arda Atahan Ibis <[email protected]>

README.md

@@ -0,0 +1,36 @@
+---
+library_name: mlx
+language:
+- en
+license: apache-2.0
+tags:
+- text-to-image
+- image-generation
+- flux
+- diffusionkit
+---
+# FLUX.1-schnell on DiffusionKit MLX!
+## Check out the [original model](https://huggingface.co/black-forest-labs/FLUX.1-schnell)!
+## Check out the [DiffusionKit](https://github.com/argmaxinc/DiffusionKit) github repository!
+![FLUX.1 [schnell] Grid](./flux_on_mac.png)
+Note: This checkpoint features 4-bit quantization of the mmdit module using MLX's nn.quantize function with default settings (group_size=64).
+# Usage
+- ## Create conda environment
+```shell
+conda create -n diffusionkit python=3.11 -y
+conda activate diffusionkit
+pip install diffusionkit
+```
+- ## Run the cli command
+```shell
+diffusionkit-cli --prompt "detailed cinematic dof render of a \
+detailed MacBook Pro on a wooden desk in a dim room with items \
+around, messy dirty room. On the screen are the letters 'FLUX on \
+DiffusionKit' glowing softly. High detail hard surface render" \
+--model-version argmaxinc/FLUX.1-schnell-4bit-quantized \
+--height 768 \
+--width 1360 \
+--seed 1001 \
+--step 4 \
+--output ~/Desktop/flux_on_mac.png
+```