Skip to content

Commit 78e5165

Browse files
author
Mik
committed
chore: readme add toc and roadmap
1 parent 904d7c3 commit 78e5165

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@
2121
2222
![Video of ColorPicker](./images/muicc-v0-2.webp)
2323

24+
## Contents
25+
26+
- [Why another ColorPicker?](#why-another-colorpicker)
27+
- [Documentation](#documentation)
28+
- [Requirements](#requirements)
29+
- [Install](#install)
30+
- [Usage](#usage)
31+
- [Roadmap](#roadmap)
32+
- [Contribute](#contribute)
33+
- [License](#license)
34+
2435
## Why another ColorPicker ?
2536

2637
- Fully compatible with Material-UI : theming and low level components
@@ -163,6 +174,22 @@ export const Container = () => (
163174

164175
[ColorButton documentation](https://mikbry.github.io/material-ui-color-components/?path=/story/components-colorbutton--basic)
165176

177+
## Roadmap
178+
179+
### v0.3.0 - [Current project](https://github.com/mikbry/material-ui-color-components/projects/1)
180+
- add Typescript support
181+
- accessibility : keyboard and touch support
182+
- localization
183+
- disable alpha property
184+
- #30, #29, #22 resolved
185+
- better documentation (colorType explained)
186+
187+
### v0.4.0
188+
- optimize code
189+
- more controls for inputs in ColorBox
190+
- remove `styled-components` to have less dependencies and reduce size
191+
- bugs fixes
192+
166193
## Contribute
167194

168195
Contributions welcome! Read the [contribution guidelines](CONTRIBUTING.md) first.

0 commit comments

Comments
 (0)