From 400a51893e3333545cb08d5939e7bbc8fcbb2a29 Mon Sep 17 00:00:00 2001 From: apio Date: Wed, 23 Nov 2022 20:50:40 +0100 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d7771d..81acebe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # minitar -Tiny C library to interact with tar archives +Tiny and easy-to-use C library to parse tar (specifically, the newer USTAR variant, which is the one pretty much everybody uses) archives ## Example @@ -35,6 +35,10 @@ int main(int argc, char** argv) The output of this example program when running it with an uncompressed tar archive is identical to that of `tar --list -f archive.tar` with the same uncompressed archive. +## Project structure + +The user-facing API (functions defined in `minitar.h` and documented in this README) is implemented in `src/tar.c`. Utility and internally-used functions live in `src/util.c`. + ## Functions ### minitar_open `struct minitar* minitar_open(const char* pathname)`