Fix license and URLs

Signed-off-by: Gris Ge <[email protected]>

Author: cathay4t

Cargo.toml

@@ -7,7 +7,7 @@ edition = "2018"
 description = "Linux kernel MPTCP path manager netlink Library"
 keywords = ["network"]
 categories = ["network-programming", "os"]
-readme = "../README.md"
+readme = "README.md"
 
 [lib]
 name = "mptcp_pm"
@@ -27,12 +27,12 @@ futures = "0.3.17"
 log = "0.4.14"
 thiserror = "1.0.29"
 tokio = { version = "1.0.1", features = ["rt"], optional = true}
-genetlink = { default-features = false, version = "0.2.1", path = "../genetlink" }
-netlink-packet-core = { version = "0.4.2", path = "../netlink-packet-core" }
-netlink-packet-generic = { version = "0.3.1", path = "../netlink-packet-generic" }
-netlink-packet-utils = { version = "0.5.1", path = "../netlink-packet-utils" }
-netlink-proto = { default-features = false, version = "0.10", path = "../netlink-proto" }
-netlink-sys = { version = "0.8.3", path = "../netlink-sys" }
+genetlink = { default-features = false, version = "0.2.1" }
+netlink-packet-core = { version = "0.4.2" }
+netlink-packet-generic = { version = "0.3.1" }
+netlink-packet-utils = { version = "0.5.1" }
+netlink-proto = { default-features = false, version = "0.10" }
+netlink-sys = { version = "0.8.3" }
 
 [dev-dependencies]
 tokio = { version = "1.11.0", features = ["macros", "rt", "rt-multi-thread"] }

LICENSE-MIT

@@ -0,0 +1,25 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+Distributions of all or part of the Software intended to be used by the
+recipients as they would use the unmodified Software, containing modifications
+that substantially alter, remove, or disable functionality of the Software,
+outside of the documented configuration mechanisms provided by the Software,
+shall be modified such that the Original Author's bug reporting email addresses
+and urls are either replaced with the contact information of the parties
+responsible for the changes, or removed entirely.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE-MIT

@@ -0,0 +1,72 @@
+[![Build Status](https://travis-ci.org/little-dude/netlink.svg?branch=master)](https://travis-ci.org/little-dude/netlink)
+
+# Netlink
+
+This project aims at providing building blocks for [netlink][man-netlink] (see `man 7 netlink`).
+
+## Organization
+
+- the [`netlink_sys`](./netlink-sys) crate provides netlink sockets. Integration with [`mio`][mio] and [`tokio`][tokio]
+  is optional.
+- Each netlink protocol has a `netlink-packet-<protocol_name>` crate that provides the packets for this protocol:
+    - [`netlink-packet-route`](./netlink-packet-route) provides messages for the [route protocol][man-rtnetlink]
+    - [`netlink-packet-audit`](./netlink-packet-audit) provides messages for the [audit][man-audit] protocol
+    - [`netlink-packet-sock-diag`](./netlink-packet-sock-diag) provides messages for the [sock-diag][man-sock-diag]
+      protocol
+    - [`netlink-packet-generic`](./netlink-packet-generic) provides message for the [generic netlink][man-genl]
+      protocol
+    - [`netlink-packet-netfilter`](./netlink-packet-netfilter) provides message for the `NETLINK_NETFILTER`
+      protocol
+- the [`netlink-packet-core`](./netlink-packet-core) is the glue for all the other `netlink-packet-*` crates. It
+  provides a `NetlinkMessage<T>` type that represent any netlink message for any sub-protocol.
+- the [`netlink_proto`](./netlink-proto) crate is an asynchronous implementation of the netlink protocol. It only
+  depends on `netlink-packet-core` for the `NetlinkMessage` type and `netlink-sys` for the socket.
+- the [`rtnetlink`](./rtnetlink) crate provides higher level abstraction for the [route protocol][man-rtnetlink]
+- the [`audit`](./audit) crate provides higher level abstractions for the audit protocol.
+- the [`genetlink`](./genetlink) crate provide higher level abstraction for the
+  [generic netlink protocol][man-genl]
+- the [`ethtool`](./ethtool) crate provide higher level abstraction for
+  [ethtool netlink protocol][ethtool-kernel-doc]
+
+
+## Altnernatives
+
+- https://github.com/jbaublitz/neli: the main alternative to these crates, as it is actively developed.
+- Other but less actively developed alternatives:
+  - https://github.com/achanda/netlink
+  - https://github.com/polachok/pnetlink
+  - https://github.com/crhino/netlink-rs
+  - https://github.com/carrotsrc/rsnl
+  - https://github.com/TaborKelly/nl-utils
+
+## Credits
+
+My main resource so far has been the source code of [`pyroute2`][pyroute2] (python) and [`netlink`][netlink-go] (golang)
+a lot. These two projects are great, and very nicely written. As someone who does not read C fluently, and that does not
+know much about netlink, they have been invaluable.
+
+I'd also like to praise [`libnl`][libnl] for its documentation. It helped me a lot in understanding the protocol basics.
+
+The whole packet parsing logic is inspired by @whitequark excellent blog posts ([part 1][whitequark-1], [part
+2][whitequark-2] and [part 3][whitequark-3], although I've only really used the concepts described in the first blog
+post).
+
+Thanks also to the people behind [tokio](tokio.rs) for the amazing
+tool they are building, and the support they provide.
+
+[man-netlink]: https://www.man7.org/linux/man-pages/man7/netlink.7.html
+[man-audit]: https://man7.org/linux/man-pages/man3/audit_open.3.html
+[man-sock-diag]: https://www.man7.org/linux/man-pages/man7/sock_diag.7.html
+[man-rtnetlink]: https://www.man7.org/linux/man-pages/man7/rtnetlink.7.html
+[man-genl]: https://www.man7.org/linux/man-pages/man8/genl.8.html
+[generic-netlink-lwn]: https://lwn.net/Articles/208755/
+[mio]: https://github.com/tokio-rs/mio
+[tokio]: https://github.com/tokio-rs/tokio
+[route-proto-doc]: https://www.infradead.org/~tgr/libnl/doc/route.html
+[netlink-go]: https://github.com/vishvananda/netlink
+[pyroute2]: https://github.com/svinota/pyroute2/tree/master/pyroute2/netlink
+[libnl]: https://www.infradead.org/~tgr/libnl
+[whitequark-1]: https://lab.whitequark.org/notes/2016-12-13/abstracting-over-mutability-in-rust
+[whitequark-2]: https://lab.whitequark.org/notes/2016-12-17/owning-collections-in-heap-less-rust
+[whitequark-3]: https://lab.whitequark.org/notes/2017-01-16/abstracting-over-mutability-in-rust-macros
+[ethtool-kernel-doc]: https://www.kernel.org/doc/html/latest/networking/ethtool-netlink.html