From 8dd1208bdd6b175b448979b9a0d99e7a8fe2083b Mon Sep 17 00:00:00 2001 From: Peter Vacho Date: Sun, 5 Jan 2025 17:21:30 +0100 Subject: [PATCH] chore: Improve readme UI, use raw HTML for the table --- README.md | 107 ++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 83 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 58e7f73..4e2e9e7 100644 --- a/README.md +++ b/README.md @@ -40,34 +40,93 @@ Repository](https://git.itsdrike.com/ap7pd/event-management-backend). Below is a showcase of key features and screens in the application: -| ![API Unreachable](showcase/01_api_unreachable.png) | ![Login Screen](showcase/02_login.png) | ![Base URL Change](showcase/02_login_base_url_change.png) | -| --------------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------- | -| Error screen, shown whenever the API becomes unreachable. | Login screen for user authentication. | Screen to update the API base URL, available from the login, register & API unreachable pages. | + -| ![Create New Category](showcase/12_new_category.png) | ![Updated Categories](showcase/13_categories_with_new.png) | ![Settings Screen](showcase/14_settings.png) | -| ---------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------- | -| Form to create a new category. | Updated list with a newly added category. | Settings menu for app configuration. Only available when logged in. | + + + + + + + + + + + + + + + + + -| ![Notification: Invite](showcase/15_notification_invite_bob.png) | ![Invite Preview](showcase/16_invite_event_details_preview.png) | ![Notification: Invite Accepted](showcase/17_notification_invite_accepted_bob.png) | -| ---------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| Notification about an (incomming) event invite. | Preview of the event from the invite. | Notification for the (incomming) invite after accepting (already marked read). | + + + + + + + + + + + + + + + + -| ![Day View with Invite](showcase/18_day_view_invited_event_bob.png) | ![Invited Event Details](showcase/19_invited_event_details_bob.png) | ![Notification Accepted John](showcase/20_notification_invite_accepted_john.png) | -| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| Day view showing the invited event. | Details of an event the user was invited to. | Notification about user having accepted an outgoing invite (from the invitor's account). | + -| ![Notifications Cleared](showcase/21_notifications_cleared.png) | -| --------------------------------------------------------------- | -| Screen showing cleared notifications. | + + + + + + + + + + +
📶 API Unreachable🔒 Login Screen🔧 Base URL Change
+ API Unreachable + + Login Screen + + Base URL Change +
Error screen, shown whenever the API becomes unreachable.Login screen for user authentication.Screen to update the API base URL.
📝 Register Screen📆 Month View📅 Day View
+ Register Screen + + Month View + + Day View +
User registration screen.Monthly calendar view to browse events.Daily event view with event details.
🗑️ Notifications Cleared
+ Notifications Cleared +
Screen showing cleared notifications.