Skip to content

Commit 29645ff

Browse files
committed
CHANGELOG: release v1.0.0
Signed-off-by: Matt Layher <[email protected]>
1 parent e3238f2 commit 29645ff

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
11
# CHANGELOG
22

33
## Unreleased
4+
5+
## v1.0.0
6+
7+
- Initial stable commit! The API is mostly a direct translation of the previous
8+
`github.com/mdlayher/raw` package APIs, with some updates to make everything
9+
focused explicitly on Linux and `AF_PACKET` sockets. Functionally, the two
10+
packages are equivalent, and `*raw.Conn` is now backed by `*packet.Conn` in
11+
the latest version of the `raw` package.

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,21 @@ Go 1.12+. Older versions of Go lack critical features and APIs which are
1313
necessary for this package to function correctly.
1414

1515
**If you depend on this package in your applications, please use Go modules.**
16+
17+
## History
18+
19+
One of my first major Go networking projects was
20+
[`github.com/mdlayher/raw`](https://github.com/mdlayher/raw), which provided
21+
access to Linux `AF_PACKET` sockets and *BSD equivalent mechanisms for sending
22+
and receiving Ethernet frames. However, the *BSD support languished and I lack
23+
the expertise and time to properly maintain code for operating systems I do not
24+
use on a daily basis.
25+
26+
Package `packet` is a successor to package `raw`, but exclusively focused on
27+
Linux and `AF_PACKET` sockets. The APIs are nearly identical, but with a few
28+
changes which take into account some of the lessons learned while working on
29+
`raw`.
30+
31+
Users are highly encouraged to migrate any existing Linux uses of `raw` to
32+
package `packet` instead. This package will be supported for the foreseeable
33+
future and will receive continued updates as necessary.

0 commit comments

Comments
 (0)