Skip to content

Commit

Permalink
pubspec & readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexisChoupault committed Feb 11, 2025
1 parent c397028 commit 83fe89e
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@

Eventide provides a easy-to-use flutter interface to access & modify native device calendars (iOS & Android).

---

### 🔥 Features
* Automatic permission handling (you can still ask for permissions manually if you want to request early at runtime)
* Add/retrieve/delete calendars
* Add/retrieve/delete events
NOTE: Eventide handles timezones as UTC. It's up to the developer to make sure he sends the right data with a [timezone aware DateTime class](https://pub.dev/packages/timezone).
* Add/delete reminders
* Custom exceptions
| | Eventide |
---- | --------------------------------
:white_check_mark: | Automatic permission handling
:white_check_mark: | Create/retrieve/delete calendars
:white_check_mark: | Create/retrieve/delete events
:white_check_mark: | Create/delete reminders
:white_check_mark: | Custom exceptions
:construction: | Recurring events
:construction: | Attendees

NOTE: Eventide handles timezones as UTC. It's up to the developer to make sure he sends the right data with a [timezone aware DateTime class](https://pub.dev/packages/timezone).

### 🚧 Work in progress
* Recurring events
* Attendees
---

### 🔨 Getting Started

Expand All @@ -37,6 +42,8 @@ To read/write calendar data, your app must include the following permissions in
<string>We need access to your calendar to add information about your trip.</string>
```

---

### 🚀 Quick start

```dart
Expand All @@ -61,6 +68,8 @@ final updatedEvent = await eventide.addReminder(

You can find more in the example app.

---

### License

Copyright © 2025 SNCF Connect & Tech. This project is licensed under the MIT License - see the LICENSE file for details.
27 changes: 27 additions & 0 deletions pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,33 @@ name: eventide
description: "A new Flutter plugin project."
version: 0.1.0
repository: https://github.com/sncf-connect-tech/eventide
topics:
- flutter
- calendar
- api
- native
- eventide
keywords:
- flutter
- calendar
- api
- native
- eventide
- sncf
- plugin
- mobile
- event management
- calendar integration
- cross-platform
- reminders
- event scheduling
- date management
- time management
- flutter plugin
- calendar events
- calendar API
- iOS calendar
- Android calendar

environment:
sdk: '>=3.3.1 <4.0.0'
Expand Down

0 comments on commit 83fe89e

Please sign in to comment.