From 61db77394c9d1cdd9607214380f7181097b78be7 Mon Sep 17 00:00:00 2001 From: Ronnie Sahlberg Date: Tue, 21 Dec 2010 20:03:13 +1100 Subject: [PATCH] README Update readme with text what libiscsi is about --- README | 17 +++++++++++++++++ TODO | 4 +++- 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/README b/README index 8b690ea..0e79515 100644 --- a/README +++ b/README @@ -1,3 +1,20 @@ +Libiscsi is a clientside library to implement the iSCSI protocol +that can be used to access resource of an iSCSI Target. + +The library is fully async with regards to iscsi commands and scsi +tasks, but a sync layer is also provided for ease of use for simpler +applications. + + +The src directory contain a handful of useful iscsi utilities +such as logging in to and enumerating all targets on a portal +and all devices of a target. + +The examples directory contain example implementation of how to +access both the sync and acync api of libiscsi. + + + Libiscsi is a work in progress. It aims to become a full async library for iscsi functionality, including all features required to establish and maintain a iscsi diff --git a/TODO b/TODO index 469898b..91894cd 100644 --- a/TODO +++ b/TODO @@ -25,7 +25,9 @@ Some features that should be added * Task management functions * Integrate with other relevant utilities such as - mtx, dverecord, ... + mtx, + dverecord, + ... * Data Digest