Merge pull request #20 from w3stling/documentation-cusip-sedol

Update documentation
w3stling · Dec 17, 2022 · 04d1448 · 04d1448
2 parents efdaf0e + 2793f64
commit 04d1448
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 8 deletions.
diff --git a/.github/README-template.md b/.github/README-template.md
@@ -28,7 +28,7 @@ Simply put, the publicly available LEI data pool can be regarded as a global dir
 
 This Java library makes it easy to lookup LEI information.
 
-Examples
+Lookup examples
 --------
 Search LEI by legal name
 ```java
@@ -54,21 +54,46 @@ LeiLookup lookup = LeiLookup.getInstance();
 Optional<Lei> lei = lookup.getLeiByBicCode("BUKBGB22XXX");
 ```
 
-Check if LEI code format valid
+Search LEI by CUSIP
+```java
+LeiLookup lookup = LeiLookup.getInstance();
+Optional<Lei> lei = lookup.getLeiByCusip("931142103");
+```
+
+Search LEI by SEDOL
+```java
+LeiLookup lookup = LeiLookup.getInstance();
+Optional<Lei> lei = lookup.getLeiBySedol("0884709");
+```
+
+Validation examples
+--------
+
+Check if LEI code format is valid
 ```java
 boolean valid = LeiCodeValidator.isValid("W22LROWP2IHZNBB6K528");
 ```
 
-Check if ISIN code format valid
+Check if ISIN code format is valid
 ```java
 boolean valid = IsinCodeValidator.isValid("US0378331005");
 ```
 
-Check if BIC code format valid
+Check if BIC code format is valid
 ```java
 boolean valid = BicCodeValidator.isValid("DEUTDEFFXXX");
 ```
 
+Check if CUSIP format is valid
+```java
+boolean valid = CusipValidator.isValid("931142103");
+```
+
+Check if SEDOL format is valid
+```java
+boolean valid = SedolValidator.isValid("0884709");
+```
+
 
 Download
 --------

diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Simply put, the publicly available LEI data pool can be regarded as a global dir
 
 This Java library makes it easy to lookup LEI information.
 
-Examples
+Lookup examples
 --------
 Search LEI by legal name
 ```java
@@ -54,21 +54,46 @@ LeiLookup lookup = LeiLookup.getInstance();
 Optional<Lei> lei = lookup.getLeiByBicCode("BUKBGB22XXX");
 ```
 
-Check if LEI code format valid
+Search LEI by CUSIP
+```java
+LeiLookup lookup = LeiLookup.getInstance();
+Optional<Lei> lei = lookup.getLeiByCusip("931142103");
+```
+
+Search LEI by SEDOL
+```java
+LeiLookup lookup = LeiLookup.getInstance();
+Optional<Lei> lei = lookup.getLeiBySedol("0884709");
+```
+
+Validation examples
+--------
+
+Check if LEI code format is valid
 ```java
 boolean valid = LeiCodeValidator.isValid("W22LROWP2IHZNBB6K528");
 ```
 
-Check if ISIN code format valid
+Check if ISIN code format is valid
 ```java
 boolean valid = IsinCodeValidator.isValid("US0378331005");
 ```
 
-Check if BIC code format valid
+Check if BIC code format is valid
 ```java
 boolean valid = BicCodeValidator.isValid("DEUTDEFFXXX");
 ```
 
+Check if CUSIP format is valid
+```java
+boolean valid = CusipValidator.isValid("931142103");
+```
+
+Check if SEDOL format is valid
+```java
+boolean valid = SedolValidator.isValid("0884709");
+```
+
 
 Download
 --------