From 0048fb49f1fa6a333091616ac3417b15dee2eca1 Mon Sep 17 00:00:00 2001 From: steen Date: Sun, 6 Mar 2022 17:24:31 +0100 Subject: [PATCH] Update README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d8b0d45..0b8b168 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,32 @@ Made in 4.0.alpha3. Things may change and break with other Godot versions. -## Using the Addon: +Now avalable on the Godot Asset Library: [Color Preview](https://godotengine.org/asset-library/asset/1252) + +## Installation +1. In the Godot Editor, got to the `AssetLib` tab +1. Search for 'Color Preview', select and Download +1. Select only the `addons/ColorPreview` folder and Install + +**Or**: 1. Download/Pull this repository 1. Add the `ColorPreview/` directory and its contents to the `addons/` directory in your Godot project -1. Enable the plugin in `Project > Project Settings... > Plugins > Enable` -Once you have done this, every line containing a Color will have a preview left of the breakpoint gutter +## Enabling the addon +Go to `Project > Project Settings... > Plugins` and Enable + +Once you have done this, every line containing a Color will have a preview left of the breakpoint gutter. +Click any preview to open a color picker where you can edit the color directly. ![Addon Preview](https://github.com/Qubus0/GodotColorPreview/blob/main/colors.png) *** -## Contributing - -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) +## Contributing [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) You are welcome to contribute to this project. Please read the [Contributing guidelines](https://github.com/Qubus0/GodotColorPreview/blob/main/CONTRIBUTING.md) for more details. + +If you find any bugs, have proposals or want to outline how to fix something without opening a Pull Request, feel free to [Open an Issue](https://github.com/Qubus0/GodotColorPreview/issues/new)