README.md
1# KArchive
2
3Reading, creating, and manipulating file archives
4
5## Introduction
6
7KArchive provides classes for easy reading, creation and manipulation of
8"archive" formats like ZIP and TAR.
9
10It also provides transparent compression and decompression of data, like the
11GZip format, via a subclass of QIODevice.
12
13## Usage
14
15If you want to read and write compressed data, just create an instance of
16KCompressionDevice and write to or read from that.
17
18If you want to read and write archive formats, create an instance of the
19appropriate subclass of KArchive (eg: K7Zip for 7-Zip files). You may need to
20combine this with usage of KCompressionDevice (see the API documentation for the
21relevant KArchive subclass for details).
22
23