Add README.md

1 files changed, 9 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1ba1eb6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+This is a simple inline implementation of the GNU functions asprintf() and
+vasprintf(). This header requires only a conforming C99 (or higher) compiler
+and standard library.
+
+The usage is identical to your system's sprintf() and vsprintf(), respectively,
+except that the first argument is a pointer to a pointer to char, rather than
+a pointer directly to a char buffer. On a successful call, a new buffer large
+enough to hold the resulting string is allocated and assigned through the
+first parameter. This buffer must be passed to free() to avoid memory leaks.
\ No newline at end of file