Skip to content

Commit 35331ea

Browse files
committed
docs: update README
1 parent 823f40b commit 35331ea

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# React Components Monorepo
22

33
- [react-typist-component](./packages/react-typist-component/README.md)
4+
- [react-use-calendar-component](./packages//react-use-calendar-component/README.md)

packages/react-use-calendar-component/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This project is aimed to provide an easy-to-use API interface for those people who want to build their own calendar component with custom style.
44

5+
## Caveat
6+
7+
This package is still under development, the API interface may change frequently.
8+
59
## Todo
610

711
- [x] Generate 42 date cell information
@@ -11,3 +15,8 @@ This project is aimed to provide an easy-to-use API interface for those people w
1115
- [ ] Support disabled date
1216
- [ ] Support displaying two calendar
1317
- [ ] Support week, month, year selection
18+
19+
## Examples
20+
21+
- [Single Mode](./src/app/components/Examples/Single.tsx)
22+
- [Multiple Mode](./src/app/components/Examples/Multiple.tsx)

0 commit comments

Comments
 (0)