Merge pull request #8 from concept7/develop

updated docs
concept7 · Sep 13, 2023 · c8a4a79 · c8a4a79
2 parents 2ba357a + 899c3c4
commit c8a4a79
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 
 All notable changes to `filament-invite` will be documented in this file.
 
-## 1.0.0 - 202X-XX-XX
+## 1.0.3 - 2023-09-13
+
+- added translatable title ``__('Accept')``
+
+## 1.0.2 - 2023-09-13
+
+- supporting Filament and Livewire v3.
+
+## 1.0.0 - 2023-09-04
+
 
-- initial release
diff --git a/README.md b/README.md
@@ -6,8 +6,9 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/concept7/filament-invite.svg?style=flat-square)](https://packagist.org/packages/concept7/filament-invite)
 
 
-
-This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
+The package will be sending out invite emails by listening to the 'created'-event on user model. The user can click a link in the email to setup their password.
+Also included is a expired check on the link.
+The link will be as following: `domain.tld/invite/accept?acceptId=<uuid>&hash=<hash>`
 
 ## Installation