update readme.md & paths-ignore (#5)

.github/workflows/android.yml

@@ -3,8 +3,12 @@ name: Android Tests
 on:
   push:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
   pull_request:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
 
 jobs:
   android-tests:

.github/workflows/flutter.yml

@@ -3,8 +3,12 @@ name: Flutter Tests
 on:
   push:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
   pull_request:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
 
 jobs:
   flutter-tests:

.github/workflows/ios.yml

@@ -3,8 +3,12 @@ name: iOS Tests
 on:
   push:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
   pull_request:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
 
 jobs:
   ios-tests:

README.md

@@ -1,30 +1,30 @@
-# Eventide
+## 📆 Eventide
 
 [![Flutter Tests](https://github.com/sncf-connect-tech/eventide/actions/workflows/flutter.yml/badge.svg)](https://github.com/sncf-connect-tech/eventide/actions/workflows/flutter.yml)
 [![Android Tests](https://github.com/sncf-connect-tech/eventide/actions/workflows/android.yml/badge.svg)](https://github.com/sncf-connect-tech/eventide/actions/workflows/android.yml)
 [![iOS Tests](https://github.com/sncf-connect-tech/eventide/actions/workflows/ios.yml/badge.svg)](https://github.com/sncf-connect-tech/eventide/actions/workflows/ios.yml)
 
 Eventide provides a easy-to-use flutter interface to access & modify native device calendars (iOS & Android).
 
-## Features
+### 🔥 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
 
-## Work in progress
+### 🚧 Work in progress
 * Recurring events
 * Attendees
 
-## Getting Started
+### 🔨 Getting Started
 
-### Android
+#### Android
 
 Nothing to add on your side. All is already declared in eventide's AndroidManifest.xml
 
-### iOS
+#### iOS
 
 To read/write calendar data, your app must include the following permissions in its info.plist file.
 
@@ -37,7 +37,7 @@ 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>
 ```
 
-## Usage Example
+### 🚀 Quick start
 
 ```dart
 import 'package:eventide/eventide.dart';
@@ -59,6 +59,8 @@ final updatedEvent = await eventide.addReminder(
 );
 ```
 
-## License
+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.