Skip to content

Commit

Permalink
chore: move docs to book (noti-rs/notibook) (#73)
Browse files Browse the repository at this point in the history
* chore: move docs to `book` (noti-rs/notibook)

* chore: update README.md with references to book
  • Loading branch information
jsonmaf1a authored Dec 18, 2024
1 parent a450e86 commit 006d6c8
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 730 deletions.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
- **Per-App Styling**: Unique notification styles for different applications
- **Modern Design**: Clean, minimalist approach to desktop notifications

## :rocket: Getting Started

The best way to get started with **Noti** is the [book](https://noti-rs.github.io/notibook).

## :inbox_tray: Installation

### 1. Install via Cargo (Recommended)
Expand Down Expand Up @@ -37,19 +41,6 @@ cargo build --release
cargo install --path .
```

## :rocket: Running Noti

### Manual Startup

```bash
# Start Noti daemon
noti run
```

### Automatic Startup

For detailed instructions on setting up automatic startup with `systemd`, please refer to the [Autostart Guide](docs/Autostart.md).

## :hammer_and_wrench: Configuration

Noti uses a TOML configuration file located at:
Expand Down Expand Up @@ -124,14 +115,14 @@ line_spacing = 5
```

> [!TIP]
> Check [ConfigProperties.md](docs/ConfigProperties.md) for comprehensive configuration options!
> Check the [book](https://noti-rs.github.io/notibook) for comprehensive configuration guide!
### :wrench: Custom layout

Want to change the banner layout? The `Noti` application provide **custom** layout by
our new brand file type `noti` with extension `.noti`!
Want to change the banner layout?
The `Noti` application offers a customizable layout using our file format, `.noti`!

**Sample of layout configuration**:
Example of layout configuration:

```noti
FlexContainer(
Expand Down Expand Up @@ -173,7 +164,7 @@ write:
display.layout = "path/to/your/File.noti"
```

Read more about it [here](./docs/Filetype.md)!
Read more about it [here](https://noti-rs.github.io/notibook/CustomLayout.html)!

## :bug: Troubleshooting

Expand Down
93 changes: 0 additions & 93 deletions docs/Autostart.md

This file was deleted.

Loading

0 comments on commit 006d6c8

Please sign in to comment.