Skip to content

Commit c466a84

Browse files
committed
update readme
1 parent 97322e3 commit c466a84

2 files changed

Lines changed: 10 additions & 26 deletions

File tree

README.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,56 +9,40 @@ Text color picker with swatches for Bard fields.
99
## Features
1010

1111
- Set text color in Bard fields
12-
- Predefined color swatches
13-
- Beautiful and easy to use color panel
14-
- Dark Mode Support
12+
- Configurable color swatches for predefined colors
13+
- And a color picker for individual colors
14+
- Seamless integration with Statamic's Control Panel design
15+
- Full support for Statamic themes and dark mode
1516

1617
## Installation
1718

18-
You can search for this addon in the `Tools > Addons` section of the Statamic control panel and click **install** or require it using Composer:
19+
Require it using Composer:
1920

2021
``` bash
2122
composer require ndx/statamic-bard-color-picker
2223
```
2324

2425
## How to use
2526

26-
Open the blueprint or fieldset that contains your Bard field, open the settings of that field and activate the text color button.
27+
Open the blueprint or fieldset containing your Bard field, then activate the text color button in the field settings.
2728

2829
![Preview of open text color panel](docs/preview.png)
2930

3031
## Configuration
3132

32-
If you want to define swatches or disable the color picker, make sure that the configuration file is published by entering the following command:
33+
To define swatches or disable the color picker, publish the configuration file:
3334

3435
``` bash
3536
php artisan vendor:publish --tag=bard-color-picker-config
3637
```
3738

38-
Have a look at the [configuration file](config/bard-color-picker.php) for details.
39-
40-
## Migrate from 1.x
41-
42-
Instead of the @simonwep/pickr package, this addon uses a native HTML color picker since v2.0. This causes some breaking changes.
43-
44-
- Statamic 5 is required
45-
- Colors are always saved in HEX format
46-
- The [configuration file](config/bard-color-picker.php) has changed completely
47-
48-
After updating from v1.x to v2.0 we recommend to republish the addon configuration, overwrite old settings and define new ones:
49-
50-
``` bash
51-
php artisan vendor:publish --tag=bard-color-picker-config --force
52-
```
53-
54-
Alternatively, you could rename the `recommended` item to `swatches` in your configuration.
55-
39+
See the [configuration file](config/bard-color-picker.php) for available options.
5640

5741
## About us
5842

59-
We develop digital solutions for all kinds of disciplines. From the idea and concepts to implementation and operation.
43+
We're a digital agency building web applications with Laravel and websites with Statamic – from initial concept to long-term maintenance.
6044

61-
Visit our website: [new-data-services.de](https://new-data-services.de/)
45+
[new-data-services.de](https://new-data-services.de/)
6246

6347
<!-- statamic:hide -->
6448

docs/preview.png

6.63 KB
Loading

0 commit comments

Comments
 (0)