From fa02e72c4a9656901935606be8de484e07b53abb Mon Sep 17 00:00:00 2001
From: Ali <info@gha3mi.com>
Date: Sat, 29 Jul 2023 07:24:55 +0200
Subject: [PATCH] Update README.

---
 README.md | 21 ++++++++++++++++++---
 1 file changed, 18 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 418daa6..670782b 100644
--- a/README.md
+++ b/README.md
@@ -31,6 +31,8 @@ I attempted several methods to decrease the noise from my laptop, but none of th
     - [turbo](#turbo)
     - [is-cpu-online](#is-cpu-online)
     - [all-nodes-info](#all-nodes-info)
+  - [API documentation](#api-documentation)
+  - [Contributing](#contributing)
 -----
 
 ## Required Linux Commands
@@ -56,8 +58,7 @@ Or you can easily include this package as a dependency in your `fpm.toml` file.
 
 ```toml
 [dependencies]
-[dependencies.forclust]
-git = "https://github.com/gha3mi/forclust.git"
+forclust = {git="https://github.com/gha3mi/forclust.git"}
 ```
 
 -----
@@ -441,4 +442,18 @@ type(cluster) :: my_pc
 call my_pc%select()
 call my_pc%print_info()
 call my_pc%deselect()
-```
\ No newline at end of file
+```
+
+## API documentation
+The most up-to-date API documentation for the master branch is available
+[here](https://gha3mi.github.io/forclust/).
+To generate the API documentation for the `ForClust` module using
+[ford](https://github.com/Fortran-FOSS-Programmers/ford) run the following
+command:
+
+```shell
+ford ford.yml
+```
+
+## Contributing
+Contributions to `ForClust` are welcome! If you find any issues or would like to suggest improvements, please open an issue.