AT-10925: Remark updates

https://amplify-education.atlassian.net/browse/AT-10925

CHANGELOG.md

@@ -5,108 +5,108 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [4.1.0] - 2023-03-09
+## \[4.1.0] - 2023-03-09
 
 ### Changed
 
-- Outdated packages updated
-- Minimum node version updated to 14
+* Outdated packages updated
+* Minimum node version updated to 14
 
-## [4.0.2] - 2022-04-11
+## \[4.0.2] - 2022-04-11
 
 ### Changed
 
-- Add integration with serverless 3 logging
-- Change Github workflows to run tests both with sls 2 and 3
+* Add integration with serverless 3 logging
+* Change Github workflows to run tests both with sls 2 and 3
 
-## [4.0.1] - 2022-04-08
+## \[4.0.1] - 2022-04-08
 
 ### Changed
 
-- Fixed audit issues. Added dependabot config
+* Fixed audit issues. Added dependabot config
 
-## [4.0.0] - 2022-04-08
+## \[4.0.0] - 2022-04-08
 
 ### Changed
 
-- Added compability with serverless 3
+* Added compability with serverless 3
 
-## [3.1.2] - 2021-09-01
+## \[3.1.2] - 2021-09-01
 
 ### Changed
 
-- Fixed y18n vulnerability
+* Fixed y18n vulnerability
 
-## [3.1.1] - 2021-09-01
+## \[3.1.1] - 2021-09-01
 
 ### Changed
 
-- Added serverless schema validation. Thank you @ROSeaboyer ([53](https://github.com/amplify-education/serverless-vpc-discovery/pull/53))
+* Added serverless schema validation. Thank you @ROSeaboyer ([53](https://github.com/amplify-education/serverless-vpc-discovery/pull/53))
 
-## [3.1.0] - 2021-09-01
+## \[3.1.0] - 2021-09-01
 
 ### Changed
 
-- Dropped support of node versions < 12
-- Replaced Travis pipeline items with GitHub workflow
+* Dropped support of node versions < 12
+* Replaced Travis pipeline items with GitHub workflow
 
-## [3.0.0] - 2020-12-24
+## \[3.0.0] - 2020-12-24
 
 ### Added
 
-- Support for getting subnets and security groups by any tag key/value
+* Support for getting subnets and security groups by any tag key/value
 
 ### Changed
 
-- ***Important!*** The `subnetNames` and `securityGroupNames` options have been deprecated and will be removed in the next major release. The new options are `subnets` and `securityGroups`.
-- ***Important!*** Drop `vpc` option support. The new option is `vpcDiscovery`.
+* ***Important!*** The `subnetNames` and `securityGroupNames` options have been deprecated and will be removed in the next major release. The new options are `subnets` and `securityGroups`.
+* ***Important!*** Drop `vpc` option support. The new option is `vpcDiscovery`.
 
-## [2.3.0] - 2020-12-11
+## \[2.3.0] - 2020-12-11
 
 ### Changed
 
-- Allow usage of wildcards in subnet and security group names. Thank you @RLRabinowitz ([#41](https://github.com/amplify-education/serverless-vpc-discovery/pull/41))
+* Allow usage of wildcards in subnet and security group names. Thank you @RLRabinowitz ([#41](https://github.com/amplify-education/serverless-vpc-discovery/pull/41))
 
-## [2.2.1] - 2020-12-02
+## \[2.2.1] - 2020-12-02
 
 ### Changed
 
-- Fixed travis build
+* Fixed travis build
 
-## [2.2.0] - 2020-12-02
+## \[2.2.0] - 2020-12-02
 
 ### Changed
 
-- Set `custom.vpcDiscovery` optional.
-- Update travis config for github release tagging
+* Set `custom.vpcDiscovery` optional.
+* Update travis config for github release tagging
 
-## [2.1.0] - 2020-11-17
+## \[2.1.0] - 2020-11-17
 
 ### Changed
 
-- ***Important!*** The `vpc` option has been deprecated but it still will work for a while. The new option is `vpcDiscovery`.
-- The VPC config applies to each function instead of the provider option.
-- Fixed logic for checking missing subnets and security groups.
+* ***Important!*** The `vpc` option has been deprecated but it still will work for a while. The new option is `vpcDiscovery`.
+* The VPC config applies to each function instead of the provider option.
+* Fixed logic for checking missing subnets and security groups.
 
 ### Added
 
-- A possibility to specify custom config for each function by specifying `function.vpcDiscovery` config
-- Added `warning` and `info` messages
+* A possibility to specify custom config for each function by specifying `function.vpcDiscovery` config
+* Added `warning` and `info` messages
 
-## [2.0.0] - 2020-11-13
+## \[2.0.0] - 2020-11-13
 
 ### Changed
 
-- The code rewritten to TypeScript. Added improvements. Updated travis config, lint and test scripts.
+* The code rewritten to TypeScript. Added improvements. Updated travis config, lint and test scripts.
 
-## [1.0.13] - 2018-10-10
+## \[1.0.13] - 2018-10-10
 
 ### Added
 
-- Added our own configuration for AWS SDK's built in retry mechanism, increasing it from 3 retries to 20 so that this plugin is more easily used in an automated environment.
+* Added our own configuration for AWS SDK's built in retry mechanism, increasing it from 3 retries to 20 so that this plugin is more easily used in an automated environment.
 
-## [1.0.12] - 2018-08-01
+## \[1.0.12] - 2018-08-01
 
 ### Added
 
-- This CHANGELOG file to make it easier for future updates to be documented. Sadly, will not be going back to document changes made for previous versions.
+* This CHANGELOG file to make it easier for future updates to be documented. Sadly, will not be going back to document changes made for previous versions.

README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://travis-ci.org/amplify-education/serverless-vpc-discovery.svg?branch=master)](https://travis-ci.org/amplify-education/serverless-vpc-discovery)
 [![npm version](https://badge.fury.io/js/serverless-vpc-discovery.svg)](https://badge.fury.io/js/serverless-vpc-discovery)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/amplify-education/serverless-vpc-discovery/master/LICENSE)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8135a66ac35648758d22e242fbdbd732)](https://app.codacy.com/gh/amplify-education/serverless-vpc-discovery/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8135a66ac35648758d22e242fbdbd732)](https://app.codacy.com/gh/amplify-education/serverless-vpc-discovery/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
 [![npm downloads](https://img.shields.io/npm/dt/serverless-vpc-discovery.svg?style=flat)](https://www.npmjs.com/package/serverless-vpc-discovery)
 
 The vpc discovery plugin takes the given vpc name, subnet tag key/value, and security group tag key/value or names in
@@ -60,7 +60,7 @@ Learn more at https://www.amplify.com
 Make sure you have the following installed before starting:
 
 * [nodejs](https://nodejs.org/en/download/)
-* [npm](https://www.npmjs.com/get-npm?utm_source=house&utm_medium=homepage&utm_campaign=free%20orgs&utm_term=Install%20npm)
+* [npm](https://www.npmjs.com/get-npm?utm_source=house\&utm_medium=homepage\&utm_campaign=free%20orgs\&utm_term=Install%20npm)
 * [serverless](https://serverless.com/framework/docs/providers/aws/guide/installation/)
 
 Also allow the lambda to have the following IAM permissions:
@@ -180,7 +180,7 @@ npm test
 
 All tests should pass.
 
-To run integration tests, set an environment variable TEST_VPC_NAME to the VPC you will be testing for. Then,
+To run integration tests, set an environment variable TEST\_VPC\_NAME to the VPC you will be testing for. Then,
 
 ```
 export AWS_PROFILE=your_profile
@@ -189,7 +189,7 @@ npm build
 npm run integration-test
 ```
 
-If there is an error build and install the node_module inside the serverless-vpc-discovery folder:
+If there is an error build and install the node\_module inside the serverless-vpc-discovery folder:
 
 ```
 npm build