From 045985e8c6138b76244da6fd472d7117f73a19bf Mon Sep 17 00:00:00 2001
From: dangowans <d.gowans@cityssm.on.ca>
Date: Fri, 4 Mar 2022 10:15:03 -0500
Subject: [PATCH] Update README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++----
 1 file changed, 31 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 85a9cb1..6dbaa95 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,44 @@
-# get-canadian-bank-name
+# Get Canadian Bank Name
+
+[![Codacy grade](https://img.shields.io/codacy/grade/c52a29dbdfa54c8b8c0733a0060d079e)](https://app.codacy.com/gh/cityssm/get-canadian-bank-name/dashboard)
+[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/cityssm/get-canadian-bank-name)](https://codeclimate.com/github/cityssm/get-canadian-bank-name)
+[![Code Climate coverage](https://img.shields.io/codeclimate/coverage/cityssm/get-canadian-bank-name)](https://codeclimate.com/github/cityssm/get-canadian-bank-name)
+[![AppVeyor](https://img.shields.io/appveyor/build/dangowans/get-canadian-bank-name)](https://ci.appveyor.com/project/dangowans/get-canadian-bank-name)
+[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/cityssm/get-canadian-bank-name)](https://app.snyk.io/org/cityssm/project/b55b9cac-29f7-4a4b-9adc-6b21e61a315b)
 
 A simple library to translate Canadian bank institution and transit numbers into the corresponding bank names.
 
 ## Installation
 
-**Coming soon**
+```sh
+npm install @cityssm/get-canadian-bank-name
+```
 
 ## Usage
 
 ```javascript
-getCanadianBankName('001');
+import { getCanadianBankName } from "@cityssm/get-canadian-bank-name";
+
+console.log( getCanadianBankName('001') );
 // -> "Bank of Montreal"
 
-getCanadianBankName('828', '14492');
+console.log( getCanadianBankName('828', '14492') );
 // => "Northern Credit Union"
 ```
+
+## Need More Information?
+
+This project was made to help validate preauthorized payment data
+tracked by the [City of Sault Ste. Marie](https://saultstemarie.ca/).
+Included institution numbers were prioritized based on the City's needs.
+
+Need some additional institution numbers for your uses?
+Need to correct a bank name that is spelt incorrectly, or has changed?
+[Create an issue](https://github.com/cityssm/get-canadian-bank-name/issues/new)
+with your request, or submit a pull request adding them.
+
+Need more details, like the address of the branch the corresponds to
+institution and transit numbers?
+[**Payments Canada** maintains a list](https://www.payments.ca/our-directories/financial-institutions-branch-directory)
+of all member banks and credit unions, along with their addresses,
+that is updated weekly.