Updates README for style and readability

Author: chaserx

README.md

@@ -1,13 +1,17 @@
 # OmniAuth GitHub Enterprise Cloud with Data Residency
 
-This is an OmniAuth strategy for authenticating with a [GitHub Enterprise Cloud with Data Residency](https://docs.github.com/en/enterprise-cloud@latest/admin/data-residency/about-github-enterprise-cloud-with-data-residency) host. 
+This is an OmniAuth strategy for authenticating with a [GitHub Enterprise Cloud with Data Residency][1] host.
 
-It extends the [Official OmniAuth GitHub strategy](https://github.com/omniauth/omniauth-github/) in the following ways: 
-- Since this version of GitHub has strict tenant boundaries, therefore the configuration options require a `enterprise_subdomain` option
-- While the official strategy has configuration options for either github.com or an [enterprise version](https://github.com/omniauth/omniauth-github/blob/master/README.md#github-enterprise-usage) (including a Data Residency version), this strategy allows for using the two strategies side by side 
+It extends the [Official OmniAuth GitHub strategy][2] in the following ways:
+
+- Since this version of GitHub has strict tenant boundaries,
+therefore the configuration options require a `enterprise_subdomain` option
+- While the official strategy has configuration options for either github.com or an
+[enterprise version][3] (including a Data Residency version),
+this strategy allows for using the two strategies side by side
 
 To use it, you'll need to sign up for an OAuth2 Application ID and Secret
-on the [developer settings view](https://github.com/settings/developers) in GitHub.
+on the [developer settings view][4] in GitHub.
 
 ## Installation
 
@@ -19,9 +23,9 @@ gem 'omniauth-github-with-data-residency', '~> 0.0.1'
 
 ### Options
 
-You are required to pass an `enterprise_subdomain` inside an `enterprise_options` options hash to build the correct client URLs.  
+You are required to pass an `enterprise_subdomain` inside an `enterprise_options` options hash to build the correct client URLs.
 
-For example, `enterprise_options: {enterprise_subdomain: "my-domain"}` will then expand to: 
+For example, `enterprise_options: {enterprise_subdomain: "my-domain"}` will then expand to:
 
 ```ruby
 
@@ -31,12 +35,13 @@ For example, `enterprise_options: {enterprise_subdomain: "my-domain"}` will then
 
 ```
 
-The `enterprise_options` are initially set in the setup phase, and you can use hooks to update strategy options before the request and callback phases. 
+The `enterprise_options` are initially set in the setup phase,
+and you can use hooks to update strategy options before the request and callback phases.
 
 Static: you can set `enterprise_options` statically by adding to the options hash.
 
-Dynamic: you can pass a proc (or another callable object) or a rack endpoint into the `setup` option. This is useful if you need to pull the subdomain from a request.
-
+Dynamic: you can pass a proc (or another callable object) or a rack endpoint into the `setup` option.
+This is useful if you need to pull the subdomain from a request.
 
 ### Basic Rails Usage with Devise
 
@@ -59,35 +64,39 @@ config.omniauth :github, ENV['GITHUB_CLIENT_ID'], ENV['GITHUB_CLIENT_SECRET'], s
 config.omniauth :github_data_residency, ENV['GITHUB_ENTERPRISE_CLIENT_ID'], ENV['GITHUB_ENTERPRISE_CLIENT_SECRET'], scope: "user:email,read:user", setup: SETUP_PROC
 ```
 
-You can use the [setup phase](https://github.com/omniauth/omniauth/wiki/Setup-Phase) to dynamically configure the `enterprise_subdomain` option for the request and callback phases.
+You can use the [setup phase][5] to dynamically configure the `enterprise_subdomain` option for the request and callback phases.
 
 ## Development
 
 ### Setup
 
-This project uses [mise](http://mise.jdx.dev/) to manage dependencies like the required Ruby version. The provided setup script uses mise by default to install Ruby before installing gems and other dependencies.
+This project uses [mise][6] to manage dependencies like the required Ruby version.
+The provided setup script uses mise by default to install Ruby before installing gems and other dependencies.
 
 After checking out the repository, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
 
 ### Local installation
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ### Release
 
-To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`. This command will create a git tag for the version, push git commits and the newly created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`.
+This command will create a git tag for the version, push git commits and the newly created tag, and push the `.gem` file to [rubygems.org][7].
 
 ### Documentation
 
-You can check the documentation with [Vale](https://vale.sh/docs). For example, run `vale sync && vale --config=./.vale.ini README.md` to install styles and check the README file.
+You can lint markdown with the following command: `bundle exec mdl *.md`. You can override styles in `md_styles.rb`. See [mdl_configuration][11] for more.
+
+You can check the documentation content with [Vale][8]. For example, run `vale sync && vale --config=./.vale.ini README.md` to install styles and check the README file.
 
 You can validate include links with this command: `lychee --no-progress --include-fragments --verbose *.md`
 
-[Vale](https://vale.sh/) and [Lychee](https://lychee.cli.rs/) are optional and not included in the [mise.toml](./mise.toml) configuration file. 
+[Vale][9] and [Lychee][10] are optional and not included in the [mise.toml](./mise.toml) configuration file.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/packfiles/omniauth-github-data-residency.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/packfiles/omniauth-github-data-residency>.
 
 ## License
 
@@ -96,3 +105,15 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ---
 
 Made with :heart: by [Packfiles :package:](https://packfiles.io)
+
+[1]: https://docs.github.com/en/enterprise-cloud@latest/admin/data-residency/about-github-enterprise-cloud-with-data-residency
+[2]: https://github.com/omniauth/omniauth-github/
+[3]: https://github.com/omniauth/omniauth-github/blob/master/README.md#github-enterprise-usage
+[4]: https://github.com/settings/developers
+[5]: https://github.com/omniauth/omniauth/wiki/Setup-Phase
+[6]: http://mise.jdx.dev/
+[7]: https://rubygems.org
+[8]: https://vale.sh/docs
+[9]: https://vale.sh/
+[10]: https://lychee.cli.rs/
+[11]: https://github.com/markdownlint/markdownlint/blob/main/docs/configuration.md