Skip to content

Commit 5a130cb

Browse files
authored
docs: update readme (#18)
1 parent 85e25ce commit 5a130cb

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
# `material-ui-color-components`
2+
3+
[![Build Status][action-image]][action-url]
4+
[![codecov][codecov-image]][codecov-url]
5+
[![NPM version][npm-image]][npm-url]
6+
[![License][license-image]][license-url]
7+
8+
[action-image]: https://github.com/mikbry/material-ui-color-components/workflows/Build%20and%20Deploy/badge.svg
9+
[action-url]: https://mikbry.github.io/material-ui-color-components/
10+
[codecov-image]: https://codecov.io/gh/mikbry/material-ui-color-components/branch/master/graph/badge.svg?token=K4P0vnM5fh
11+
[codecov-url]: https://codecov.io/gh/mikbry/material-ui-color-components
12+
[npm-image]: https://img.shields.io/npm/v/material-ui-color-components.svg
13+
[npm-url]: https://npmjs.org/package/material-ui-color-components
14+
[license-image]: https://img.shields.io/npm/l/amaterial-ui-color-components.svg
15+
[License-url]:./LICENSE
16+
217
[WIP] Collections of color components for `material-ui` components for React Material-UI. Highly customizable and theming support !
318

419
![WIP](./images/wip.png)
@@ -12,17 +27,29 @@
1227

1328
## `<ColorPicker/>`
1429

30+
TODO : doc
31+
32+
## `<ColorBox />`
33+
34+
TODO : doc
35+
1536
## `<ColorInput />`
1637

38+
TODO : doc
39+
1740
## `<ColorPalette />`
1841

42+
TODO : doc
43+
1944
## `<ColorButton />`
2045

46+
TODO : doc
47+
2148
## WIP
2249
TODO list
2350
- [x] init project
2451
- [x] create simple color picker
25-
- [ ] create color tools/helpers
26-
- [ ] tests / coverages
52+
- [x] create color tools/helpers
53+
- [ ] tests / coverage
2754
- [ ] publish
2855
- [ ] documentation

images/wip.png

-4.86 KB
Loading

0 commit comments

Comments
 (0)