From 7767d93c7ce14395d2ed307e5cd5a32cf72eb5a8 Mon Sep 17 00:00:00 2001
From: "T.Tian" <alchem0x2a@gmail.com>
Date: Tue, 5 Nov 2024 10:32:16 +0800
Subject: [PATCH] add link to readme for doc

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 3770b860..fbfa7af8 100644
--- a/README.md
+++ b/README.md
@@ -37,12 +37,20 @@ For a full list of publications in the SPARC-X project please refer to:
 - [M-SPARC development](https://github.com/SPARC-X/M-SPARC?tab=readme-ov-file#6-citation)
 - [Pseudopotentials](https://github.com/SPARC-X/SPMS-psps?tab=readme-ov-file#citation)
 
+## Documentation
+
+Please check the [full
+documentation](https://sparc-x.github.io/sparc-x-api) for details
+regarding installation, usage, troubleshooting and contribution
+guidelines.
+
 ## Acknowledgment
 The authors gratefully acknowledge the support of the U.S. Department
 of Energy, Office of Science, under Grant No. DE-SC0019410 and
 DE-SC0023445.
 
 
+
 <!-- [Fig. 1](#fig-1-schematic-drawing-for-the-architecture-of-the-sparc-x-api-package) provides an overlook of the components of `SPARC-X-API` and its relation with the SPARC C-code. -->
 
 <!-- #### Fig. 1 Schematic drawing for the architecture of the `SPARC-X-API` package -->