From 6ef31ffdcba42c33d06915b5dd6117623b2d706a Mon Sep 17 00:00:00 2001 From: "kayos@tcp.direct" Date: Sat, 9 Oct 2021 02:45:04 -0700 Subject: [PATCH] Update: README.md --- README.md | 55 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 33 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 036914a..85aa30d 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ -

-

girc, a flexible IRC library for Go

+

+

girc-atomic, a terrifying fork of an IRC library for Go

- Build Status - Coverage Status - GoDoc - Go Report Card - IRC Chat + GoDoc + Go Report Card + IRC Chat

## Fork changes @@ -13,42 +11,49 @@ [Click here to see the changes in girc-atomic vs girc](https://github.com/lrstanley/girc/compare/master...yunginnanet:master) ## Status + +### ₜₕₑ ₛₖy ᵢₛ 𝆑ₐₗₗᵢₙg ʇɥǝ sʞʎ ᴉs ⅎɐʅʅᴉuƃ +### 𝚝𝚑𝚎𝚢 𝚜𝚑𝚘𝚞𝚕𝚍 𝚑𝚊𝚟𝚎 𝚕𝚒𝚜𝚝𝚎𝚗𝚎𝚍 -**girc is fairly close to marking the 1.0.0 endpoint, which will be tagged as + +~~girc is fairly close to marking the 1.0.0 endpoint, which will be tagged as necessary, so you will be able to use this with care knowing the specific tag -you're using won't have breaking changes** +you're using won't have breaking changes~~ ## Features - Focuses on simplicity, yet tries to still be flexible. -- Only requires [standard library packages](https://godoc.org/git.tcp.direct/kayos/girc-atomic?imports) -- Event based triggering/responses ([example](https://godoc.org/git.tcp.direct/kayos/girc-atomic#ex-package--Commands), and [CTCP too](https://godoc.org/git.tcp.direct/kayos/girc-atomic#Commands.SendCTCP)!) -- [Documentation](https://godoc.org/git.tcp.direct/kayos/girc-atomic) is _mostly_ complete. +- Only requires [standard library packages](https://godoc.org/github.com/yunginnanet/girc-atomic?imports) +- Event based triggering/responses ([example](https://godoc.org/github.com/yunginnanet/girc-atomic#ex-package--Commands), and [CTCP too](https://godoc.org/github.com/yunginnanet/girc-atomic#Commands.SendCTCP)!) +- [Documentation](https://godoc.org/github.com/yunginnanet/girc-atomic) is _mostly_ complete. - Support for almost all of the [IRCv3 spec](http://ircv3.net/software/libraries.html). - SASL Auth (currently only `PLAIN` and `EXTERNAL` is support by default, however you can simply implement `SASLMech` yourself to support additional mechanisms.) - Message tags (things like `account-tag` on by default) - - `account-notify`, `away-notify`, `chghost`, `extended-join`, etc -- all handled seemlessly ([cap.go](https://git.tcp.direct/kayos/girc-atomic/blob/master/cap.go) for more info). + - `account-notify`, `away-notify`, `chghost`, `extended-join`, etc -- all handled seemlessly ([cap.go](https://github.com/yunginnanet/girc-atomic/blob/master/cap.go) for more info). - Channel and user tracking. Easily find what users are in a channel, if a user is away, or if they are authenticated (if the server supports it!) -- Client state/capability tracking. Easy methods to access capability data ([LookupChannel](https://godoc.org/git.tcp.direct/kayos/girc-atomic#Client.LookupChannel), [LookupUser](https://godoc.org/git.tcp.direct/kayos/girc-atomic#Client.LookupUser), [GetServerOption (ISUPPORT)](https://godoc.org/git.tcp.direct/kayos/girc-atomic#Client.GetServerOption), etc.) +- Client state/capability tracking. Easy methods to access capability data ([LookupChannel](https://godoc.org/github.com/yunginnanet/girc-atomic#Client.LookupChannel), [LookupUser](https://godoc.org/github.com/yunginnanet/girc-atomic#Client.LookupUser), [GetServerOption (ISUPPORT)](https://godoc.org/github.com/yunginnanet/girc-atomic#Client.GetServerOption), etc.) - Built-in support for things you would commonly have to implement yourself. - - Nick collision detection and prevention (also see [Config.HandleNickCollide](https://godoc.org/git.tcp.direct/kayos/girc-atomic#Config).) + - Nick collision detection and prevention (also see [Config.HandleNickCollide](https://godoc.org/github.com/yunginnanet/girc-atomic#Config).) - Event/message rate limiting. - - Channel, nick, and user validation methods ([IsValidChannel](https://godoc.org/git.tcp.direct/kayos/girc-atomic#IsValidChannel), [IsValidNick](https://godoc.org/git.tcp.direct/kayos/girc-atomic#IsValidNick), etc.) - - CTCP handling and auto-responses ([CTCP](https://godoc.org/git.tcp.direct/kayos/girc-atomic#CTCP)) - - And more! + - Channel, nick, and user validation methods ([IsValidChannel](https://godoc.org/github.com/yunginnanet/girc-atomic#IsValidChannel), [IsValidNick](https://godoc.org/github.com/yunginnanet/girc-atomic#IsValidNick), etc.) + - CTCP handling and auto-responses ([CTCP](https://godoc.org/github.com/yunginnanet/girc-atomic#CTCP)) + - ~~And more!~~ + - GOTTA GO FAST YOU GOTTA GO REALLY FAST + - you can power hundreds of clients at the same time with this now ## Installing - $ go get -u git.tcp.direct/kayos/girc-atomic + ~~$ go get -u github.com/yunginnanet/girc-atomic~~ + just use go modules probably ## Examples -See [the examples](https://godoc.org/git.tcp.direct/kayos/girc-atomic#example-package--Bare) +See [the examples](https://godoc.org/github.com/yunginnanet/girc-atomic#example-package--Bare) within the documentation for real-world usecases. Here are a few real-world -usecases/examples/projects which utilize girc: +usecases/examples/projects which utilize the real girc: | Project | Description | | --- | --- | @@ -60,6 +65,10 @@ Working on a project and want to add it to the list? Submit a pull request! ## Contributing +~~Please review the [CONTRIBUTING](CONTRIBUTING.md) doc for submitting issues/a guide +on submitting pull requests and helping out.~~ + +**OH GOD PLEASE MAKE IT STOP** Please review the [CONTRIBUTING](CONTRIBUTING.md) doc for submitting issues/a guide on submitting pull requests and helping out. @@ -85,7 +94,9 @@ on submitting pull requests and helping out. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -girc artwork licensed under [CC 3.0](http://creativecommons.org/licenses/by/3.0/) based on Renee French under Creative Commons 3.0 Attributions. +girc artwork licensed under [CC 3.0](http://creativecommons.org/licenses/by/3.0/) based on Renee French under Creative Commons 3.0 Attributions... + + or so I'm told. Then it was defiled by [some idiot](https://github.com/yunginnanet). ## References