diff --git a/README.md b/README.md
index 3690031..7b3735d 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,25 @@
-[
](https://supportukrainenow.org)
-
-# The popular Datetime Picker as a Filament Field
+# Flatpickr Date/Time Picker as a Filament Field
[](https://packagist.org/packages/savannabits/filament-flatpickr)
[](https://github.com/savannabits/filament-flatpickr/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/savannabits/filament-flatpickr/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/savannabits/filament-flatpickr)
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
-
-## Support us
+Flatpickr is one of the most popular js datepickers. This filament plugin allows you to use flatpickr as a Filament Field without the sweat of configuration.
-[
](https://spatie.be/github-ad-click/filament-flatpickr)
+
+
-We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-
-We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
+## Features
+- Configure easily using fluent (chained) methods
+- Supports an optional month Selector
+- Supports an optional week selector
+- Support for both light and dark modes
+- Specify the theme (among the available themes) as a configuration
+- Supports Range Selection mode
+- Supports multiple date selection mode
+- And many more features are coming...
## Installation
@@ -26,13 +29,6 @@ You can install the package via composer:
composer require savannabits/filament-flatpickr
```
-You can publish and run the migrations with:
-
-```bash
-php artisan vendor:publish --tag="filament-flatpickr-migrations"
-php artisan migrate
-```
-
You can publish the config file with:
```bash
@@ -43,21 +39,67 @@ This is the contents of the published config file:
```php
return [
+ 'default_theme' => 'airbnb', // 'default','dark','material_blue','material_green','material_red','material_orange','airbnb','confetti'
];
```
+If you are using a custom filament theme (using tailwind.config.js), append the following to `tailwind.config.js` under `content` for proper styling:
+```js
+module.exports = {
+ content: [
+ ...,
+ './vendor/savannabits/filament-flatpickr/**/*.blade.php', // <== Add this line
+ ],
+```
-Optionally, you can publish the views using
+## Usage
+Use the `Flatpickr` field anywhere in your filament forms as shown in the following examples
+```php
+use Savannabits\Flatpickr\Flatpickr;
-```bash
-php artisan vendor:publish --tag="filament-flatpickr-views"
+// Basic, Date Field
+Flatpickr::make('read_at')->default(now()),
```
+
-## Usage
+```php
+// Datetime field
+Flatpickr::make('read_at')->enableTime(),
+```
+
+```php
+// Month Selector field
+Flatpickr::make('read_at')->monthSelect(),
+```
+
```php
-$flatpickr = new Savannabits\Flatpickr();
-echo $flatpickr->echoPhrase('Hello, Savannabits!');
+// Date Range picker field
+Flatpickr::make('read_at')->rangePicker(),
+```
+
+
+```php
+// Specify the Date format
+Flatpickr::make('read_at')->dateFormat('Y-m-d'),
+
+// Toggle AltInput (true by default) and set Alt Display Format:
+Flatpickr::make('read_at')->altInput(true)->altFormat('F J Y'),
```
+
+```php
+// Specify the input Date Format
+Flatpickr::make('read_at')->dateFormat('d/m/Y')->altInput(false),
+```
+
+
+```php
+// Specify the Datepicker's Theme: See for https://flatpickr.js.org/themes/ available themes
+Flatpickr::make('read_at')->theme('material_red'),
+```
+
+## Automatic dark mode:
+
+
## Testing