File: README.md

package info (click to toggle)
rust-swayipc 3.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 120 kB
  • sloc: makefile: 4
file content (28 lines) | stat: -rw-r--r-- 1,207 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# swayipc   [![Action Badge]][actions] [![Version Badge]][crates.io] [![License Badge]][license] [![Docs Badge]][docs]

[Version Badge]: https://img.shields.io/crates/v/swayipc.svg
[crates.io]: https://crates.io/crates/swayipc
[Action Badge]: https://github.com/JayceFayne/swayipc-rs/workflows/Rust/badge.svg
[actions]: https://github.com/JayceFayne/swayipc-rs/actions
[License Badge]: https://img.shields.io/crates/l/swayipc.svg
[license]: https://github.com/JayceFayne/swayipc-rs/blob/master/LICENSE.md
[Docs Badge]: https://docs.rs/swayipc/badge.svg
[docs]: https://docs.rs/swayipc

A Rust library for controlling swaywm through its [IPC interface](https://github.com/swaywm/sway/blob/master/sway/sway-ipc.7.scd).

## Usage

Examples of how to use the library can be found [here](../examples).

## i3 compatibility

[i3](https://github.com/i3/i3) compatibility is kept if possible even though this library primarily targets sway.

## Versioning

This library targets the latest stable release of [sway](https://github.com/swaywm/sway).

## Contributing

 If you find any errors in swayipc or just want to add a new feature feel free to [submit a PR](https://github.com/jaycefayne/swayipc-rs/pulls).