wanderer/go-sway
1
0
Fork 0
mirror of https://github.com/joshuarubin/go-sway synced 2024-11-22 12:02:00 +01:00
Code Issues Releases Activity

add LICENSE and README

Browse Source 
Signed-off-by: Joshua Rubin <me@jawa.dev>
This commit is contained in:
Joshua Rubin 2019-04-14 21:56:30 -06:00
parent e0aebc16e7
commit b11e8903a3
No known key found for this signature in database
GPG Key ID: 673103A1CC175722
3 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2019 Joshua Rubin
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

18
README.md Normal file
View File

@ -0,0 +1,18 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/joshuarubin/go-sway)](https://goreportcard.com/report/github.com/joshuarubin/go-sway) [![GoDoc](https://godoc.org/github.com/joshuarubin/go-sway?status.svg)](https://godoc.org/github.com/joshuarubin/go-sway)
This package simplifies working with the [sway](https://swaywm.org/) IPC from Go.
It was highly influenced by the [i3 package](https://github.com/i3/go-i3).
While the i3 and sway IPCs share much in common, they are not identical. This package provides the complete sway api.
## Differences from the i3 package
* Retries are not handled. Use tools like systemd to automatically restart apps that use this library.
* A much simpler interface for subscriptions and handling events.
* No global state.
* Use of Context throughout.
## Assumptions
* The `$SWAYSOCK` variable must be set properly in the environment
* sway is running on a machine with the same byteorder as the client

0
socket_test.go → sway_test.go
View File