Skip to content

Commit ebf149a

Browse files
committed
docs: update README features section for clarity and detail
1 parent 23f22d9 commit ebf149a

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,26 @@
3131

3232
A configurable, themeable and non-intrusive server-rendered toast notification component for Go web applications. Built with [templ](https://github.com/a-h/templ) library for seamless integration with Go-based web frontends.
3333

34-
### Features
35-
36-
- **No External Dependencies**: Built with native Go and the `templ` library, requiring no external frontend dependencies.
37-
- **Multiple Toasts**: Support to display multiple toast notifications.
38-
- **Configurable**: Customize appearance (bordered, rounded), behavior, and position.
39-
- **Variants**: Provide toast style variants like `Accent`, `AccentLight` and `AccentDark`.
40-
- **Themeable**: Use CSS variables to theme your toasts to match your application's design.
41-
- **Icon Support**: Include default SVG icons for various toast levels (such as success, error, info, etc.), allowing you to use your preferred icons.
42-
- **Positioning**: Flexible positioning of toast messages (top-right, bottom-left, etc.).
43-
- **Progress Bar for Auto-Dismiss**: A visual progress bar indicates the countdown until the toast will automatically dismiss (with auto-dismiss enabled only).
44-
- **Animations**: Entrance and exit animations for toast notifications.
45-
- _Default Animations_: built-in animations for toasts appearing and disappearing.
46-
- _Custom Animations_: Customize animations via CSS variables or integrate with external CSS animation libraries.
47-
- _Animation Control_: Full control over animation timing, easing, delay and effects, via CSS variables.
48-
- _Disable Animations Option_: Ability to completely disable animations, providing flexibility for different application needs and user preferences.
49-
5034
<div style="display: flex; justify-content: center;">
51-
<img src="statics/demo.gif" alt="Image" >
35+
<img src="https://raw.githubusercontent.com/indaco/goaster/gh-assets/demo.gif" alt="Image" >
5236
</div>
5337

38+
### Features
39+
40+
- **No External Dependencies**: Built with native Go and the [`templ`](https://templ.guide) library—no JavaScript or frontend dependencies required.
41+
- **Multiple Toasts**: Supports displaying multiple toast notifications simultaneously.
42+
- **Highly Configurable**: Customize appearance (bordered, rounded), behavior, and position to fit your UI.
43+
- **Variants**: Includes style variants such as `Accent`, `AccentLight`, and `AccentDark`.
44+
- **Themeable**: Easily theme your toasts using CSS variables to match your app’s design.
45+
- **Icon Support**: Comes with default SVG icons for common toast types (success, error, info, etc.)—or use your own.
46+
- **Flexible Positioning**: Display toast messages in any corner (top-right, bottom-left, etc.).
47+
- **Auto-Dismiss Progress Bar**: Visual progress indicator for toast duration (when auto-dismiss is enabled).
48+
- **Smooth Animations**:
49+
- _Built-in Animations_: Default entrance and exit transitions.
50+
- _Custom Animations_: Define your own via CSS variables or external animation libraries.
51+
- _Animation Control_: Fine-tune timing, easing, delay, and effects with CSS variables.
52+
- _Disable Option_: Disable all animations when needed (e.g., for accessibility or testing).
53+
5454
## Installation
5555

5656
Ensure your project is using Go Modules.

0 commit comments

Comments
 (0)