Skip to content

Commit

Permalink
docs: update description, move preview up
Browse files Browse the repository at this point in the history
  • Loading branch information
roosta committed Jan 22, 2025
1 parent c9664d3 commit 171acb5
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 11 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@ i3wsr - i3 workspace renamer
[![Test Status](https://github.com/roosta/i3wsr/actions/workflows/test.yaml/badge.svg?branch=main)](https://github.com/roosta/i3wsr/actions)
[![Crates.io](https://img.shields.io/crates/v/i3wsr)](https://crates.io/crates/i3wsr)

A workspace renamer for [i3](https://i3wm.org/) and [Sway](https://swaywm.org/)
window managers that dynamically updates workspace names based on their
content. It monitors window events and renames workspaces to show the
applications running in them.
A dynamic workspace renamer for i3 and Sway that updates names to reflect their
active applications.

`i3wsr` can be configured through command-line flags or a `TOML` config file,
offering extensive customization of workspace names, icons, aliases, and
display options.

## Preview

![preview](https://raw.githubusercontent.com/roosta/i3wsr/main/assets/preview.gif)

## Rebrand and Wayland support

Expand All @@ -22,10 +28,6 @@ before publishing anything under a new name.
Development forward will focus on Sway, but backward compatibility with I3 will
be maintained.

## Preview

![preview](https://raw.githubusercontent.com/roosta/i3wsr/main/assets/preview.gif)

## Requirements

i3wsr requires [i3](https://i3wm.org/) or [sway](https://swaywm.org/), and
Expand Down
6 changes: 3 additions & 3 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
//! # i3wsr - i3/Sway Workspace Renamer
//!
//! A workspace renamer for i3 and Sway window managers that dynamically updates workspace names
//! based on their content. It monitors window events and renames workspaces to show the applications
//! running in them.
//!
//! A dynamic workspace renamer for i3 and Sway that updates names to reflect their
//! active applications.
//!
//! ## Usage
//!
Expand Down

0 comments on commit 171acb5

Please sign in to comment.