birchwood/README.md

![](branding/logo_small.png)

# birchwood

## _A sane IRC framework for the D language_

> [13:51:00] <zh_> A sane IRC framework for the D language
>> [13:51:11] <zh_> s/sane/professional

![DUB](https://img.shields.io/dub/v/birchwood?color=%23c10000ff%20&style=flat-square) ![DUB](https://img.shields.io/dub/dt/birchwood?style=flat-square) ![DUB](https://img.shields.io/dub/l/birchwood?style=flat-square)

## Installation

To add birchwood to your project simply run:

```bash
dub add birchwood
```

### Dependencies

Birchwood depends on the following D libraries:

* `libsnooze` (at least 1.3.0-beta)
* `eventy` (at least 0.4.0)
* `dlog` (at least 0.3.19)

## Usage

You can take a look at the `Client` API documentation on [DUB](https://birchwood.dpldocs.info/birchwood.client.client.Client.html).

## Compatibility

- [x] [rfc1459](https://www.rfc-editor.org/rfc/rfc1459)
   * Supports all the numeric codes
- [x] [rfc2812](https://www.rfc-editor.org/rfc/rfc2812)
   * Supports all the numeric codes

More standards will be added within the next month or so, mostly relating to new response codes that just need to be added.

## Credits

* [supremestdoggo](https://github.com/supremestdoggo)
   * Adding IRC message formatting code (`267f8886150dbd40eb5c2fecb9d7e3a4c8dfd71f`)

## License

See [LICENSE](LICENSE).
- FIxed layout from not rendering on dub 2023-06-21 11:13:53 +02:00			`![](branding/logo_small.png)`
Fixed centering for GitHub markdown rendering 2022-10-30 17:54:45 +02:00
- FIxed layout from not rendering on dub 2023-06-21 11:13:53 +02:00			`# birchwood`
Added README along with branding 2022-10-30 16:59:23 +02:00
- FIxed layout from not rendering on dub 2023-06-21 11:13:53 +02:00			`## _A sane IRC framework for the D language_`
Added README along with branding 2022-10-30 16:59:23 +02:00
Lekker 2023-06-29 00:13:56 +02:00			`> [13:51:00] <zh_> A sane IRC framework for the D language`
			`>> [13:51:11] <zh_> s/sane/professional`
New test shows the server name here could be anything so we have a working basic prototype (v0.0.1 onwards) 2022-11-01 14:08:04 +02:00
- Added shields 2023-06-21 11:11:01 +02:00			`![DUB](https://img.shields.io/dub/v/birchwood?color=%23c10000ff%20&style=flat-square) ![DUB](https://img.shields.io/dub/dt/birchwood?style=flat-square) ![DUB](https://img.shields.io/dub/l/birchwood?style=flat-square)`

Added README along with branding 2022-10-30 16:59:23 +02:00			`## Installation`

			`To add birchwood to your project simply run:`

			```bash
			`dub add birchwood`
			```

Added dependencies to the README 2022-11-26 18:12:05 +02:00			`### Dependencies`

README - Typo fix 2023-03-18 13:04:08 +02:00			`Birchwood depends on the following D libraries:`
Added dependencies to the README 2022-11-26 18:12:05 +02:00
- Corrected required version of `libsnooze` 2023-06-30 13:09:08 +02:00			* `libsnooze` (at least 1.3.0-beta)
README - Upgraded required libsnooze version - Typo fixes 2023-06-25 17:03:23 +02:00			* `eventy` (at least 0.4.0)
			* `dlog` (at least 0.3.19)
Added dependencies to the README 2022-11-26 18:12:05 +02:00
Added README along with branding 2022-10-30 16:59:23 +02:00			`## Usage`

READSME update 2023-06-30 13:19:14 +02:00			You can take a look at the `Client` API documentation on [DUB](https://birchwood.dpldocs.info/birchwood.client.client.Client.html).
README - Added todos for now 2022-11-01 14:03:10 +02:00
Fix typo in README 2023-03-13 20:47:01 +02:00			`## Compatibility`
Added notice on supported standards 2022-11-05 17:01:12 +02:00
Updated IRC compatibility information 2023-03-16 13:03:16 +02:00			`- [x] [rfc1459](https://www.rfc-editor.org/rfc/rfc1459)`
			`* Supports all the numeric codes`
			`- [x] [rfc2812](https://www.rfc-editor.org/rfc/rfc2812)`
			`* Supports all the numeric codes`
Added notice on supported standards 2022-11-05 17:01:12 +02:00
			`More standards will be added within the next month or so, mostly relating to new response codes that just need to be added.`

README - Added credits to supremestdoggo 2023-03-18 13:02:56 +02:00			`## Credits`

			`* [supremestdoggo](https://github.com/supremestdoggo)`
			* Adding IRC message formatting code (`267f8886150dbd40eb5c2fecb9d7e3a4c8dfd71f`)

Set license to LGPL 3.0 2022-10-30 17:05:19 +02:00			`## License`

Fixed centering for GitHub markdown rendering 2022-10-30 17:54:45 +02:00			`See [LICENSE](LICENSE).`