Skip to content

Commit

Permalink
readme: switch to soft-wrapping lines
Browse files Browse the repository at this point in the history
  • Loading branch information
belak committed Sep 11, 2022
1 parent 299505e commit 310088a
Showing 1 changed file with 10 additions and 27 deletions.
37 changes: 10 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,44 +4,29 @@
[![Build Status](https://img.shields.io/github/workflow/status/go-irc/irc/CI.svg)](https://github.com/go-irc/irc/actions)
[![Coverage Status](https://img.shields.io/coveralls/go-irc/irc.svg)](https://coveralls.io/github/go-irc/irc?branch=master)

This package was originally created to only handle message parsing,
but has since been expanded to include small abstractions around
connections and a very general client type with some small
conveniences.
This package was originally created to only handle message parsing, but has since been expanded to include small abstractions around connections and a very general client type with some small conveniences.

This library is not designed to hide any of the IRC elements from
you. If you just want to build a simple chat bot and don't want to
deal with IRC in particular, there are a number of other libraries
which provide a more full featured client if that's what you're
looking for.
This library is not designed to hide any of the IRC elements from you. If you just want to build a simple chat bot and don't want to deal with IRC in particular, there are a number of other libraries which provide a more full featured client if that's what you're looking for.

This library is meant to stay as simple as possible so it can be a
building block for other packages.
This library is meant to stay as simple as possible so it can be a building block for other packages.

This library aims for API compatibility whenever possible. New
functions and other additions will not result in a major version
increase unless they break the API. This library aims to follow
the semver recommendations mentioned on gopkg.in.
This library aims for API compatibility whenever possible. New functions and other additions will not result in a major version increase unless they break the API. This library aims to follow the semver recommendations mentioned on gopkg.in.

This packages uses newer error handling APIs so, only go 1.13+ is officially supported.

## Import Paths

All development happens on the `master` branch and when features are
considered stable enough, a new release will be tagged.
All development happens on the `master` branch and when features are considered stable enough, a new release will be tagged.

* `gopkg.in/irc.v4` should be used to develop against the commits
tagged as stable
* `gopkg.in/irc.v4` should be used to develop against the commits tagged as stable

## Development

In order to run the tests, make sure all submodules are up to date. If you are
just using this library, these are not needed.
In order to run the tests, make sure all submodules are up to date. If you are just using this library, these are not needed.

## Notes on Unstable APIs

Currently the ISupport and Tracker APIs are considered unstable - these may be
broken or removed with minor version changes, so use them at your own risk.
Currently the ISupport and Tracker APIs are considered unstable - these may be broken or removed with minor version changes, so use them at your own risk.

## Major Version Changes

Expand All @@ -57,10 +42,8 @@ broken or removed with minor version changes, so use them at your own risk.

### v2

- CTCP messages will no longer be rewritten. The decision was made that this
library should pass through all messages without mangling them.
- Remove Message.FromChannel as this is not always accurate, while
Client.FromChannel should always be accurate.
- CTCP messages will no longer be rewritten. The decision was made that this library should pass through all messages without mangling them.
- Remove Message.FromChannel as this is not always accurate, while Client.FromChannel should always be accurate.

### v1

Expand Down

0 comments on commit 310088a

Please sign in to comment.