From 00b2beadc647d84e4b911dcc6776f069fbf22335 Mon Sep 17 00:00:00 2001
From: akila94 <akilaaroshanaa@gmail.com>
Date: Thu, 12 Dec 2024 10:34:05 +0530
Subject: [PATCH] Add build notes to readme file

---
 README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 64 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9bd8b877..d9f83dce 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,64 @@
-Please refer to the official documentation [here](https://ob.docs.wso2.com/en/latest/)
+<!--
+ ~ Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ ~
+ ~ WSO2 LLC. licenses this file to you under the Apache License,
+ ~ Version 2.0 (the "License"); you may not use this file except
+ ~ in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~     http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+
+# WSO2 Financial Services Accelerator
+
+Financial Services Accelerator is a collection of technologies that increases the speed and reduces the complexity of adopting open banking compliance.
+
+### Building from the source
+
+If you want to build Financial Services Accelerator from the source code:
+
+1. Install Java8 or above.
+1. Install [Apache Maven 3.0.5](https://maven.apache.org/download.cgi) or above.
+1. Install [MySQL](https://dev.mysql.com/doc/refman/5.5/en/windows-installation.html).
+1. To get the Financial Services Accelerator from [this repository](https://github.com/wso2/financial-services-accelerator.git), click **Clone or download**.
+    * To **clone the solution**, copy the URL and execute the following command in a command prompt.
+      `git clone <the copiedURL>`. After cloning, checkout to the **main** branch.
+    * To **download the pack**, select the branch **main** first, then click **Download ZIP** and unzip the downloaded file.
+1. Navigate to the downloaded solution using a command prompt and run the Maven command.
+
+   |  Command | Description                                                                                                                                                                      |
+               | :--- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+   | ```mvn install``` | This starts building the pack without cleaning the folders.                                                                                                                      |
+   | ```mvn clean install``` | This cleans the folders and starts building the solution pack from scratch.                                                                                                      |
+   | ```mvn clean install -P solution``` | This cleans the folders and starts building the solution pack from scratch. Finally creates the accelerator zip files containing the artifacts required to setup the deployment. |
+
+1. Once the build is created, navigate to the relevant folder to get the accelerator for each product.
+
+| Product                                 | Toolkit Path                                                |
+      |:----------------------------------------|:------------------------------------------------------------|
+| ```Identity Server Accelerator```       | `/financial-services-accelerator/accelerators/fs-is/target` |
+| ```API Manager Accelerator```           | `/financial-services-accelerator/accelerators/fs-apim/target`     |
+
+### Running the products
+
+Please refer the following READ.ME files to run the products.
+
+| Product                            | Instructions Path                          |
+|:-----------------------------------|:-------------------------------------------|
+| ```Identity Server```              | `/wso2-fs-iam-accelerator-4.0.0/README.md` |
+| ```API Manager```                  | `/wso2-fs-am-accelerator-4.0.0/README.md`  |
+
+### Reporting Issues
+
+We encourage you to report issues, documentation faults, and feature requests regarding the Financial Services Accelerator through the [WSO2 Financial Services Accelerator Issue Tracker](https://github.com/wso2/financial-services-accelerator/issues).
+
+### License
+
+This source is licensed under the Apache License Version 2.0 ([LICENSE](LICENSE)).