Skip to content

Commit

Permalink
docs: Fix badge, update toc, fix section placement
Browse files Browse the repository at this point in the history
  • Loading branch information
roosta committed Nov 11, 2023
1 parent 37c4858 commit 3e74e5f
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
i3wsr - i3 workspace renamer
======

[![Test Status](https://github.com/roosta/i3wsr/actions/workflows/test.yml/badge.svg?branch=develop)](https://github.com/roosta/i3wsr/actions)
[![Test Status](https://github.com/roosta/i3wsr/actions/workflows/test.yaml/badge.svg?branch=develop)](https://github.com/roosta/i3wsr/actions)
[![Crates.io](https://img.shields.io/crates/v/i3wsr)](https://crates.io/crates/i3wsr)


`i3wsr` is a small program that uses [I3's](https://i3wm.org/) [IPC Interface](https://i3wm.org/docs/ipc.html)
to change the name of a workspace based on its contents.

## Table of content
## TOC

- [Table of content](#table-of-content)
- [i3wsr - i3 workspace renamer](#i3wsr---i3-workspace-renamer)
- [TOC](#toc)
- [Details](#details)
- [Requirements](#requirements)
- [Installation](#installation)
Expand All @@ -19,11 +21,11 @@ to change the name of a workspace based on its contents.
- [Keeping part of the workspace name](#keeping-part-of-the-workspace-name)
- [Configuration / options](#configuration--options)
- [Aliases](#aliases)
- [Display property](#display-property)
- [Aliases based on property](#aliases-based-on-property)
- [Class](#class)
- [Instance](#instance)
- [Name](#name)
- [Display property](#display-property)
- [Icons](#icons)
- [Separator](#separator)
- [Default icon](#default-icon)
Expand Down Expand Up @@ -169,18 +171,6 @@ use that and if not, then check instance, then finally use class
> Deprecation note: previously `wm_property` defined which prop to check for
> aliases, but this newer approach will allow for multiple types of aliases
### Display property

Which property to display if no aliases if found:

```toml
[general]
display_property = "instance"
```

Possible options are `class`, `instance`, and `name`, and will default to `class`
if not present.

#### Class

This is the default, and the most succinct.
Expand Down Expand Up @@ -229,6 +219,18 @@ It should be possible to write a launcher script, that wraps whatever
command your running with a custom i3 ipc trigger event. If anyone figures out
a nice way of doing it let me know.

### Display property

Which property to display if no aliases if found:

```toml
[general]
display_property = "instance"
```

Possible options are `class`, `instance`, and `name`, and will default to `class`
if not present.

### Icons

You can configure icons for your WM property, a very basic preset for
Expand Down

0 comments on commit 3e74e5f

Please sign in to comment.