diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..8c8d520 --- /dev/null +++ b/readme.md @@ -0,0 +1,37 @@ +# Repo Name +Describe what this repo is all about including a link to more details in Confluence. +## Dependant repos +Describe any other repos this is dependant on to be tested/deployed. +# How to Build locally +### Prerequisites +This is an example of how to list things you need to use the software and how to install them. +- npm +```sh +npm install npm@latest -g +``` +### Installation +_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._ +1. Get a free API Key at [https://example.com](https://example.com) +2. Clone the repo +```sh +git clone https://github.com/your_username_/Project-Name.git +``` +3. Install NPM packages +```sh +npm install +``` +4. Enter your API in `config.js` +```js +const API_KEY = 'ENTER YOUR API'; +``` +## How to deploy +Describe how to deploy +## How to test +Describe how to test +## Acknowledgments +List resources you find helpful and would like to give credit to. +- +- +- +# Copyright +The code in this repository is the property of LV Financial Services and its related companies