Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Qubus0 authored Mar 6, 2022
1 parent 79f0ee7 commit 0048fb4
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <kbd>Download</kbd>
1. Select only the `addons/ColorPreview` folder and <kbd>Install</kbd>

**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 <kbd>Enable</kbd>


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)

0 comments on commit 0048fb4

Please sign in to comment.