Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #20

Merged
merged 1 commit into from
Dec 17, 2022
Merged

Update documentation #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions .github/README-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
--------
Expand Down
33 changes: 29 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
--------
Expand Down