Skip to content

Commit 300a66a

Browse files
committed
Update README
1 parent 9c0253a commit 300a66a

File tree

1 file changed

+35
-39
lines changed

1 file changed

+35
-39
lines changed

README.md

Lines changed: 35 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,34 @@
66
Flat, Simple, Hackable Color-Picker.
77
</h3>
88

9+
<h5 align="center">
10+
<a href="https://simonwep.github.io/pickr/">Fully Featured Demo</a>
11+
</h5>
12+
913
<br/>
1014

1115
<p align="center">
12-
<img alt="gzip size" src="https://img.badgesize.io/https://raw.githubusercontent.com/Simonwep/pickr/master/dist/pickr.min.js?compression=gzip&style=flat-square">
13-
<img alt="brotli size" src="https://img.badgesize.io/https://raw.githubusercontent.com/Simonwep/pickr/master/dist/pickr.min.js?compression=brotli&style=flat-square">
1416
<a href="https://travis-ci.org/Simonwep/pickr"><img
1517
alt="Build Status"
16-
src="https://img.shields.io/travis/Simonwep/pickr.svg?style=popout-square"></a>
18+
src="https://github.com/simonwep/pickr/actions/workflows/ci.yml/badge.svg"></a>
1719
<a href="https://www.npmjs.com/package/@simonwep/pickr"><img
1820
alt="Download count"
19-
src="https://img.shields.io/npm/dm/@simonwep/pickr.svg?style=popout-square"></a>
20-
<img alt="No dependencies" src="https://img.shields.io/badge/dependencies-none-27ae60.svg?style=popout-square">
21+
src="https://img.shields.io/npm/dm/@simonwep/pickr.svg"></a>
22+
<img alt="No dependencies" src="https://img.shields.io/badge/dependencies-none-27ae60.svg">
2123
<a href="https://www.jsdelivr.com/package/npm/@simonwep/pickr"><img
2224
alt="JSDelivr download count"
23-
src="https://data.jsdelivr.com/v1/package/npm/@simonwep/pickr/badge"></a>
25+
src="https://data.jsdelivr.com/v1/package/npm/@simonwep/pickr/badge?style=rounded"></a>
2426
<img alt="Current version"
25-
src="https://img.shields.io/github/tag/Simonwep/pickr.svg?color=3498DB&label=version&style=flat-square">
27+
src="https://img.shields.io/github/tag/Simonwep/pickr.svg?color=3498DB&label=version">
2628
<a href="https://github.com/sponsors/Simonwep"><img
2729
alt="Support me"
28-
src="https://img.shields.io/badge/github-support-3498DB.svg?style=popout-square"></a>
30+
src="https://img.shields.io/badge/github-support-3498DB.svg"></a>
2931
<a href="https://gitpod.io/#https://github.com/Simonwep/pickr"><img
3032
alt="Gitpod Ready-to-Code"
31-
src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod&style=popout-square"
33+
src="https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod"
3234
/></a>
3335
</p>
3436

35-
<br>
36-
37-
<h4 align="center">
38-
<a href="https://simonwep.github.io/pickr/">Fully Featured demo</a>
39-
</h4>
40-
4137
<p align="center">
4238
<a href="https://opencollective.com/pickr/donate" target="_blank">
4339
<img src="https://user-images.githubusercontent.com/30767528/63641974-ade08c80-c6b7-11e9-827a-faa526b5c2bf.png" height="37"/>
@@ -50,28 +46,28 @@
5046
<br>
5147

5248
### Features
53-
* Themes
54-
* Simple usage
55-
* Zero dependencies
56-
* Multiple color representations
57-
* Color comparison
58-
* Opacity control
59-
* Detail adjustments via. mouse-wheel
60-
* Responsive and auto-positioning
61-
* Supports touch devices
62-
* Swatches for quick-selection
63-
* Fully accessible and i18n
64-
* [Shadow-dom support](#selection-through-a-shadow-dom)
49+
* 🎨 Themes
50+
* 🔄 Simple usage
51+
* 🚫 Zero dependencies
52+
* 🌈 Multiple color representations
53+
* 🔍 Color comparison
54+
* 🎚️ Opacity control
55+
* 🖱️ Detail adjustments via mouse-wheel
56+
* 📱 Responsive and auto-positioning
57+
* 👆 Supports touch devices
58+
* 🎨 Swatches for quick-selection
59+
* Fully accessible and i18n
60+
* 🌑 Shadow-dom support
6561

6662
### Status of this project
67-
This project might continue to get important security- and bug-related updates but its _feature set_ is frozen, and it's highly unlikely that it'll get new features or enhancements.
68-
69-
The reason behind this decision is the way this tool has been build (monolithic, the core is one single file, everything is in plain JS etc.) which makes it incredible hard to maintain, tests become impossible at this stage without a complete rewrite, and the fun is gone at such a level of cramped complexity.
7063

64+
> [!IMPORTANT]
65+
> This project might continue to get important security- and bug-related updates but its _feature set_ is frozen, and it's highly unlikely that it'll get new features or enhancements.
66+
>
67+
> The reason behind this decision is the way this tool has been build (monolithic, the core is one single file, everything is in plain JS etc.) which makes it incredible hard to maintain, tests become impossible at this stage without a complete rewrite, and the fun is gone at such a level of cramped complexity.
68+
>
7169
> Personally I recommend building these UI-Related "widgets" directly into the app with the framework you're using which takes more time but in return gives you full power of how it should work and look like. Frameworks such as [(p)react](https://preactjs.com/), [vue](https://vuejs.org/) and [svelte](https://svelte.dev/) will make it a breeze to develop such things within a day.
7270
73-
**As of 2021, this project is no longer maintained!**
74-
7571
### Themes
7672
|Classic|Monolith|Nano|
7773
|-------|--------|----|
@@ -337,8 +333,8 @@ const pickr = new Pickr({
337333
cmyk: false, // Display 'input/output format as cmyk' button (cyan mangenta yellow key )
338334

339335
input: false, // Display input/output textbox which shows the selected color value.
340-
// the format of the input is determined by defaultRepresentation,
341-
// and can be changed by the user with the buttons set by hex, rgba, hsla, etc (above).
336+
// the format of the input is determined by defaultRepresentation,
337+
// and can be changed by the user with the buttons set by hex, rgba, hsla, etc (above).
342338
cancel: false, // Display Cancel Button, resets the color to the previous state
343339
clear: false, // Display Clear Button; same as cancel, but keeps the window open
344340
save: false, // Display Save Button,
@@ -375,10 +371,10 @@ Example setup:
375371
<div class="entry">
376372
#shadow-root
377373
<div class="innr">
378-
<div class="another">
379-
#shadow-root
380-
<div class="pickr"></div>
381-
</div>
374+
<div class="another">
375+
#shadow-root
376+
<div class="pickr"></div>
377+
</div>
382378
</div>
383379
</div>
384380
```
@@ -446,7 +442,7 @@ If `silent` is true (Default is false), the button won't change the current colo
446442
* createFromTemplate(str`:String`) _- See [inline doumentation](https://github.com/Simonwep/pickr/blob/master/src/js/lib/utils.js#L88)._
447443
* resolveElement(val`:String|HTMLElement`) _- Resolves a `HTMLElement`, supports `>>>` as shadow dom selector._
448444
* adjustableInputNumbers(el`:InputElement`, mapper`:Function`) _- Creates the possibility to change the numbers in an inputfield via mouse scrolling.
449-
The mapper function takes three arguments: the matched number, an multiplier and the index of the match._
445+
The mapper function takes three arguments: the matched number, an multiplier and the index of the match._
450446

451447
Use this utils carefully, it's not for sure that they will stay forever!
452448

0 commit comments

Comments
 (0)