Add Linting & Formatting Tooling to the README (#184)

## 📔 Objective

Add linting and formatting tooling info to the readme.

## ⏰ Reminders before review

- Contributor guidelines followed
- All formatters and local linters executed and passed
- Written new unit and / or integration tests where applicable
- Protected functional changes with optionality (feature flags)
- Used internationalization (i18n) for all UI strings
- CI builds passed
- Communicated to DevOps any deployment requirements
- Updated any necessary documentation (Confluence, contributing docs) or
informed the documentation
  team

## 🦮 Reviewer guidelines

<!-- Suggested interactions but feel free to use (or not) as you desire!
-->

- 👍 (`:+1:`) or similar for great changes
- 📝 (`:memo:`) or ℹ️ (`:information_source:`) for notes or general info
- ❓ (`:question:`) for questions
- 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry
that's not quite a confirmed
  issue and could potentially benefit from discussion
- 🎨 (`:art:`) for suggestions / improvements
- ❌ (`:x:`) or ⚠️ (`:warning:`) for more significant problems or
concerns needing attention
- 🌱 (`:seedling:`) or ♻️ (`:recycle:`) for future improvements or
indications of technical debt
- ⛏ (`:pick:`) for minor or nitpick changes

Author: coltonhurst

README.md

@@ -115,20 +115,34 @@ The list of developer tools is:
   `cargo install cargo-nextest --locked`. It can be manually run using
   `cargo nextest run --all-features`
 
-## Cargo fmt
+## Formatting & Linting
 
-We use certain unstable features for formatting which require the nightly version of cargo-fmt.
+This repository uses various tools to check formatting and linting before it's merged. It's
+recommended to run the checks prior to submitting a PR.
 
-To install:
+### Installation
 
-```
-rustup component add rustfmt --toolchain nightly
-```
+Please see the [lint.yml](./.github/workflows/lint.yml) file for example installation commands &
+versions. Here are the cli tools we use:
+
+- Nightly [cargo fmt](https://github.com/rust-lang/rustfmt) and
+  [cargo udeps](https://github.com/est31/cargo-udeps)
+- [rust clippy](https://github.com/rust-lang/rust-clippy)
+- [cargo sort](https://github.com/DevinR528/cargo-sort)
+- [prettier](https://github.com/prettier/prettier)
 
-To run:
+### Checks
+
+To verify if changes need to be made, here are examples for the above tools:
 
 ```
-cargo +nightly fmt
+export RUSTFLAGS="-D warnings"
+
+cargo +nightly fmt --check
+cargo +nightly udeps --workspace --all-features
+cargo clippy --all-features --tests
+cargo sort --workspace --check
+npm run lint
 ```
 
 ## Contribute