Skip to content

Commit 310088a

Browse files
committed
readme: switch to soft-wrapping lines
1 parent 299505e commit 310088a

File tree

1 file changed

+10
-27
lines changed

1 file changed

+10
-27
lines changed

README.md

+10-27
Original file line numberDiff line numberDiff line change
@@ -4,44 +4,29 @@
44
[![Build Status](https://img.shields.io/github/workflow/status/go-irc/irc/CI.svg)](https://github.com/go-irc/irc/actions)
55
[![Coverage Status](https://img.shields.io/coveralls/go-irc/irc.svg)](https://coveralls.io/github/go-irc/irc?branch=master)
66

7-
This package was originally created to only handle message parsing,
8-
but has since been expanded to include small abstractions around
9-
connections and a very general client type with some small
10-
conveniences.
7+
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.
118

12-
This library is not designed to hide any of the IRC elements from
13-
you. If you just want to build a simple chat bot and don't want to
14-
deal with IRC in particular, there are a number of other libraries
15-
which provide a more full featured client if that's what you're
16-
looking for.
9+
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.
1710

18-
This library is meant to stay as simple as possible so it can be a
19-
building block for other packages.
11+
This library is meant to stay as simple as possible so it can be a building block for other packages.
2012

21-
This library aims for API compatibility whenever possible. New
22-
functions and other additions will not result in a major version
23-
increase unless they break the API. This library aims to follow
24-
the semver recommendations mentioned on gopkg.in.
13+
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.
2514

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

2817
## Import Paths
2918

30-
All development happens on the `master` branch and when features are
31-
considered stable enough, a new release will be tagged.
19+
All development happens on the `master` branch and when features are considered stable enough, a new release will be tagged.
3220

33-
* `gopkg.in/irc.v4` should be used to develop against the commits
34-
tagged as stable
21+
* `gopkg.in/irc.v4` should be used to develop against the commits tagged as stable
3522

3623
## Development
3724

38-
In order to run the tests, make sure all submodules are up to date. If you are
39-
just using this library, these are not needed.
25+
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.
4026

4127
## Notes on Unstable APIs
4228

43-
Currently the ISupport and Tracker APIs are considered unstable - these may be
44-
broken or removed with minor version changes, so use them at your own risk.
29+
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.
4530

4631
## Major Version Changes
4732

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

5843
### v2
5944

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

6548
### v1
6649

0 commit comments

Comments
 (0)