renamed to swayipc

README.md

@@ -1,26 +1,32 @@
-[![Go Report Card](https://goreportcard.com/badge/github.com/tlinden/i3ipc)](https://goreportcard.com/report/github.com/tlinden/i3ipc) 
-[![Actions](https://github.com/tlinden/i3ipc/actions/workflows/ci.yaml/badge.svg)](https://github.com/tlinden/i3ipc/actions)
-![GitHub License](https://img.shields.io/github/license/tlinden/i3ipc)
-[![GoDoc](https://godoc.org/github.com/tlinden/i3ipc?status.svg)](https://godoc.org/github.com/tlinden/i3ipc)
+[![Go Report Card](https://goreportcard.com/badge/github.com/tlinden/swayipc)](https://goreportcard.com/report/github.com/tlinden/swayipc) 
+[![Actions](https://github.com/tlinden/swayipc/actions/workflows/ci.yaml/badge.svg)](https://github.com/tlinden/swayipc/actions)
+![GitHub License](https://img.shields.io/github/license/tlinden/swayipc)
+[![GoDoc](https://godoc.org/github.com/tlinden/swayipc?status.svg)](https://godoc.org/github.com/tlinden/swayipc)
 
-# i3ipc - go bindings to control sway (and possibly i3)
+# swayipc - go bindings to control sway (and possibly i3)
 
-This is a go module which you can use to control [sway](https://swaywm.org/),
-[swayfx](https://github.com/WillPower3309/swayfx) and possibly [i3wm](http://i3wm.org/).
+Package swayipc can be used to control [sway](https://swaywm.org/),
+[swayfx](https://github.com/WillPower3309/swayfx) and possibly
+[i3wm](http://i3wm.org/) window managers via a unix domain socket.
 
 ## About
-i3ipc's interprocess communication (or ipc)  is the interface i3wm and
-sway  use  to  receive  commands  from  client  applications  such  as
-i3-msg. It  also features a publish/subscribe  mechanism for notifying
-interested parties of window manager events.
 
-i3ipc is a go module for  controlling the window manager. This project
+swaywm's interprocess  communication (or  ipc) is the  interface sway,
+swayfx and i3wm use to  receive commands from client applications such
+as  sway-msg.   It  also  features  a  publish/subscribe  mechanism  for
+notifying interested parties of window manager events.
+
+swayipc is a go module for  controlling the window manager. This project
 is intended to  be useful for general scripting,  and for applications
 that interact  with the  window manager  like status  line generators,
-notification daemons, and window pagers.
+notification daemons, and window pagers. It is primarily designed to
+work with sway and swayfx, but may also work with i3wm, although I
+haven't tested it on i3wm.
+
+The module uses the i3-IPC proctocol as outlined in sway-ipc(7).
 
 For details on how to use the library, see the
-[reference documentation](https://godoc.org/github.com/tlinden/i3ipc).
+[reference documentation](https://godoc.org/github.com/tlinden/swayipc).
 
 ## Example usage
 
@@ -33,11 +39,11 @@ import (
         "fmt"
         "log"
 
-        "github.com/tlinden/i3ipc"
+        "github.com/tlinden/swayipc"
 )
 
 func main() {
-        ipc := i3ipc.NewI3ipc()
+        ipc := swayipc.NewSwayIPC()
 
         err := ipc.Connect()
         if err != nil {
@@ -69,7 +75,7 @@ which is using this module.
 
 Execute this to add the module to your project:
 ```sh
-go get github.com/tlinden/i3ipc
+go get github.com/tlinden/swayipc
 ```
 
 ## Acknowledgements
@@ -80,12 +86,12 @@ one is not just a port of it and has been written from scratch.
 
 ## Getting help
 
-Although I'm happy to hear from i3ipc users in private email, that's the
+Although I'm happy to hear from swayipc users in private email, that's the
 best way for me to forget to do something.
 
 In order to report a bug,  unexpected behavior, feature requests or to
 submit    a    patch,    please    open   an    issue    on    github:
-https://github.com/TLINDEN/i3ipc/issues.
+https://github.com/TLINDEN/swayipc/issues.
 
 ## Copyright and license
 
@@ -97,7 +103,7 @@ T.v.Dein <tom AT vondein DOT org>
 
 ## Project homepage
 
-https://github.com/TLINDEN/i3ipc
+https://github.com/TLINDEN/swayipc
 
 ## Copyright and License