From 4ac2d3e1fe5e403095ca1b45d69387ddc22c9e36 Mon Sep 17 00:00:00 2001
From: Mucka <96072629+M-U-C-K-A@users.noreply.github.com>
Date: Mon, 6 Nov 2023 17:23:43 +0100
Subject: [PATCH] Update readme.md
Added Syntax Highlighting for Improved Readability
---
readme.md | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/readme.md b/readme.md
index eed9cf3..d91df5c 100644
--- a/readme.md
+++ b/readme.md
@@ -34,7 +34,7 @@ This mf-tool java library provides simple APIs/functions/methods to work
## Installation
##### Maven
-```
+```xml
-```
+```java
MFTool tool = new MFTool();
tool.matchingScheme("Axis"); //-- get a list of all schemes with Axis in its name
tool.getCurrentNav("120503"); //-- get current nav
@@ -62,13 +62,13 @@ The other available methods are described in the next section.
Multiple methods provide ways to work with mutual funds and related data. Those are listed below in detail.
### 1. How to initialize an MFTool object
-```
+```java
MFTool tool = new MFTool();
```
This will create the object for you, but it's recommended that you create this object as a singleton object.
The object uses a caching mechanism, which under-the-hood caches the values of historic nav and other static information to improve the performance.
If you are using the Spring project, you can create the bean in ``@Configuration`` configuration class.
-```
+```java
@Configuration
public class MFToolConfig{
@Bean
@@ -79,7 +79,7 @@ public class MFToolConfig{
}
```
You can use MFTool in other services using ``@Inject`` or ``@autowired`` annotation.
-```
+```java
@Service
public class MyService {
@@ -93,7 +93,7 @@ public class MyService {
```
### 2. How to fetch a list of all mutual fund schemes
-```
+```java
@Service
public class MyService {
@@ -107,7 +107,7 @@ public class MyService {
```
### 3. How to fetch a list of all schemes matching a keyword
-```
+```java
@Service
public class MyService {
@@ -125,7 +125,7 @@ public class MyService {
An example schemeCode is 120503 (_Axis Long Term Equity Fund - Direct Plan - Growth Option_).
When we fetch a list of mutual funds, we get the scheme-name, and its corresponding schemeCode.
A scheme code uniquely identifies the mutual fund scheme.
-```
+```java
@Service
public class MyService {
@@ -141,7 +141,7 @@ public class MyService {
### 5. NAV on specific date for the scheme
LocalDate is used to define the date. For example:
``LocalDate date = LocalDate.parse("2021-07-13");``
-```
+```java
@Service
public class MyService {
@@ -156,7 +156,7 @@ public class MyService {
### 6. List of historic NAV for the scheme
This method provides a list of all the NAVs for the given scheme.
-```
+```java
@Service
public class MyService {
@@ -173,5 +173,5 @@ public class MyService {
## Issue
This repository is maintained actively, so if you face any issue please raise an issue.
-