Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
howljs authored Sep 24, 2024
1 parent c049aaa commit 1116bca
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
# 📅 React Native Calendar Kit

## Status: Development
## Status: In Progress

React Native Calendar component, fully implemented using react-native-gesture-handler and react-native-reanimated. Support pinch to zoom, drag and drop to create/update event.

[![Version][npm-shield]][npm-link]
[![PayPal_Me][paypal-me-shield]][paypal-me]
[![ko-fi][ko-fi-shield]][ko-fi-profile]

## Features
- Support all day events.
- Support drag/drop to create/edit event.
- Support hiding the days of the week.
- Support scrolling by day.
- Support Pinch to zoom.
- Support recurring events.

## Demo:
### iOS:

https://github.com/user-attachments/assets/9a099b37-6898-4e05-87d9-c8fd82e16c63

### Android:

https://github.com/user-attachments/assets/3896a8c8-4cde-4f76-8621-168be4cba74b

## Installation

Using Yarn:
Expand Down Expand Up @@ -69,6 +86,10 @@ Using NPM:
$ npm install --save react-native-haptic-feedback
```

## Documentation

The documentation for version 2.0.0 hasn’t been updated yet, so follow the code from the [example](https://github.com/howljs/react-native-calendar-kit) if you want to use the library early.

## TODO:
- [ ] Update documentation
- [ ] Cache events to speed up rendering
Expand All @@ -79,4 +100,4 @@ $ npm install --save react-native-haptic-feedback
[paypal-me-shield]: https://img.shields.io/static/v1.svg?label=%20&message=PayPal.Me&logo=paypal
[paypal-me]: https://www.paypal.me/j2teamlh
[ko-fi-profile]: https://ko-fi.com/W7W6G75FH
[npm-link]: https://www.npmjs.com/package/@howljs/calendar-kit
[npm-link]: https://www.npmjs.com/package/@howljs/calendar-kit

0 comments on commit 1116bca

Please sign in to comment.