]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
added link to API documentation
authorYann Collet <cyan@fb.com>
Mon, 13 Mar 2017 21:45:16 +0000 (14:45 -0700)
committerYann Collet <cyan@fb.com>
Mon, 13 Mar 2017 21:45:16 +0000 (14:45 -0700)
index.html

index d55bf0764d0887115d790d97caad79f2164fd005..0cfce2fc10a812c2be9ffaeaa690ce66aa1646b1 100644 (file)
@@ -165,6 +165,15 @@ Dictionary gains are mostly effective in the first few KB. Then, the compression
 `zstd -D dictionaryName --decompress FILE.zst`
 
 
+### A rich API set :
+
+Zstandard API is designed with learning curve in mind.
+At the top, you'll find simple methods, using trivial arguments and behavior.
+Then, at each new paragraph, the API introduces new concepts and parameters,
+giving gradually more control for advanced usages.
+
+You can learn more about Zstandard API by reading [its documentation](http://facebook.github.io/zstd/zstd_manual.html).
+
 <br/>
 <a name="other-languages"></a>
 ## Bindings for other languages