From fdf71c17822f3f11cb8f8cc8b5141396d8eac942 Mon Sep 17 00:00:00 2001 From: Pablo Neira Ayuso Date: Thu, 8 Apr 2010 23:16:26 +0200 Subject: add new README file Signed-off-by: Pablo Neira Ayuso --- README | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) (limited to 'README') diff --git a/README b/README index 9bd9414..481875e 100644 --- a/README +++ b/README @@ -1,9 +1,23 @@ -libmnl += What is libmnl? = -Features: -- Minimalistic Netlink library -- Low-level: you have to know how Netlink works. -- Simplicity: as opposed to complexity. -- Very low abstraction: try to leak as less Netlink details as possible. -- Decoupling: the main bricks are decoupled to avoid inter-dependencies -(eg. socket handling and callbacks are not attached). +libmnl is a minimalistic user-space library oriented to Netlink developers. +There are a lot of common tasks in parsing, validating, constructing of +both the Netlink header and TLVs that are repetitive and easy to get wrong. +This library aims to provide simple helpers that allows you to re-use code +and to avoid re-inventing the wheel. The main features of this library are: + +* Small: the shared library requires around 20KB in a x86-based computer. +* Simple: this library avoids complexity and elaborated abstractions that +tend to hide Netlink details. +* Easy to use: the library simplifies the work for Netlink-wise developers. +It provides functions to make socket handling, message building, validating, +parsing, and sequence tracking, easier. +* Easy to re-use: you can use the library to build your own abstraction layer +on top of this library. +* Decoupling: the interdependency of the main bricks that compose the library +is reduced, eg. the library provides many helpers but the programmer is not +forced to use them. + +-- +08/apr/2010 +Pablo Neira Ayuso -- cgit v1.2.3