From fbeade6e5cdef8d0a843bf9587e62a3da0adbe3c Mon Sep 17 00:00:00 2001 From: Lin Zhihao <59785146+LinZhihao-723@users.noreply.github.com> Date: Tue, 16 Apr 2024 21:52:05 -0400 Subject: [PATCH] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index efcafd84..d3ee6ac5 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,10 @@ project homepage on PyPI [here][16]. Tested on Python 3.7, 3.8, 3.11 and 3.12, and it should work on any Python version >= 3.7. +## API Documentation + +The documentation of APIs in this library can be found in [YScope Docs][19]. + ## Building/Packaging To manually build a package for distribution, follow the steps below. @@ -316,3 +320,4 @@ other package management tools such as `apt-get`: [16]: https://pypi.org/project/clp-ffi-py/ [17]: https://github.com/RaRe-Technologies/smart_open [18]: https://taskfile.dev/installation/ +[19]: https://docs.yscope.com/clp-ffi-py/main/api/clp_ffi_py.html