From: Yann Collet <yann.collet.73@gmail.com>
Date: Thu, 10 Mar 2016 00:09:41 +0000 (+0100)
Subject: minor doc clarifications
X-Git-Tag: v0.6.0^2~17^2~74
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dcc000f0eb63b8a315fbdddbbf1fa11217766817;p=thirdparty%2Fzstd.git

minor doc clarifications
---

diff --git a/lib/README.md b/lib/README.md
index a04455488..91ef00c40 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -13,6 +13,11 @@ The __lib__ directory contains several files, but depending on target use case,
 
 ##### zstd core compression
 
+Stable API is exposed in [zstd.h].
+Advanced and experimental API is exposed in `zstd_static.h`.
+`zstd_static.h` API elements should be used with static linking only,
+as their definition may change in future version of the library.
+
 - [bitstream.h](bitstream.h)
 - fse.c
 - fse.h
@@ -24,13 +29,15 @@ The __lib__ directory contains several files, but depending on target use case,
 - zstd_decompress.c
 - zstd_internal.h
 - zstd_opt.h
-- zstd.h
+- [zstd.h]
 - zstd_static.h
 
+[zstd.h]: zstd.h
+
 #### Buffered streaming
 
 This complementary API makes streaming integration easier.
-It is used by `zstd` command line utility :
+It is used by `zstd` command line utility, and [7zip plugin](http://mcmilk.de/projects/7-Zip-ZStd) :
 
 - zbuff.c
 - zbuff.h