Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(README): improve Features section with actual features list #99

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,19 @@

## :star2: Features

- **Native Wayland Support**: Seamlessly integrated with Wayland
- **Highly Configurable**: Detailed customization options for appearance and behavior
- **Per-App Styling**: Unique notification styles for different applications
- **Modern Design**: Clean, minimalist approach to desktop notifications
| status | feature |
| :----: | :-------------------- |
| ✅ | Hot-reload |
| ✅ | CLI |
| ✅ | Per-App configuration |
| ✅ | Themes |
| ✅ | Idle |
| ✅ | Custom layout |
| ✅ | Gradients |
| 🚧 | `Do-Not-Disturb` mode |
| 🚧 | History |
| 🚧 | Actions |
| ❌ | Audio |

## :rocket: Getting Started

Expand Down Expand Up @@ -73,7 +82,7 @@ radius = 10
[display.image]
max_size = 64
margin = { right = 25 }
# For old computers you can use simplier resizing method
# For old computers you can use simpler resizing method
# resizing_method = "nearest"

[display.text]
Expand Down Expand Up @@ -120,7 +129,7 @@ line_spacing = 5
### :wrench: Custom layout

Want to change the banner layout?
The `Noti` application offers a customizable layout using our file format, `.noti`!
`Noti` offers a customizable layout using our file format, `.noti`!

Example of layout configuration:

Expand Down Expand Up @@ -157,8 +166,7 @@ FlexContainer(
}
```

To enable this feature, write your own layout in file and in main config file
write:
To enable this feature, write your own layout in file and in main config file write:

```toml
display.layout = "path/to/your/File.noti"
Expand Down
2 changes: 1 addition & 1 deletion crates/client/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ pub struct NotiClient<'a> {
dbus_client: dbus::client::Client<'a>,
}

impl<'a> NotiClient<'a> {
impl NotiClient<'_> {
pub async fn init() -> anyhow::Result<Self> {
let client = dbus::client::Client::init().await?;
Ok(Self {
Expand Down
2 changes: 1 addition & 1 deletion crates/dbus/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pub struct Client<'a> {
proxy: NotificationsProxy<'a>,
}

impl<'a> Client<'a> {
impl Client<'_> {
pub async fn init() -> anyhow::Result<Self> {
debug!("D-Bus Client: Initializing");
let connection = Connection::session().await?;
Expand Down
Loading