From: Sean Purcell <me@seanp.xyz>
Date: Wed, 19 Apr 2017 00:03:37 +0000 (-0700)
Subject: Update README
X-Git-Tag: v1.2.0^2~38^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F666%2Fhead;p=thirdparty%2Fzstd.git

Update README
---

diff --git a/lib/README.md b/lib/README.md
index 3357e3d87..8fa60a20f 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -22,6 +22,14 @@ Some additional API may be useful if you're looking into advanced features :
                           They are not "stable", their definition may change in the future.
                           Only static linking is allowed.
 
+#### ZSTDMT API
+
+To enable building the multithreaded compression API, use the `make lib-mt` target.
+The header file zstdmt_compress.h (in compress/) provides the prototypes for the API.
+If linking a program that uses the ZSTDMT API against libzstd.a on a POSIX system,
+the -pthread flag must be provided to the compiler at link time.
+Note that these prototypes may still be used in a version built without multithread support,
+but they will be single threaded (i.e. no benefits will be given over the standard ZSTD API).
 
 #### Modular build