[IMPROVED] Audited README files for consistency, formatting, and style

1Password / scim-examples

1Password SCIM Bridge deployment examples

https://support.1password.com/scim/

MIT License

148 stars 141 forks source link

[IMPROVED] Audited README files for consistency, formatting, and style #237

Closed Penderworth closed 1 year ago

Penderworth commented 1 year ago

This PR is a full audit and edit of the main READMEs in this repo. Changes include:

Reworked headers for consistency
Added table of contents
Edited for style and readability
Removed specifics for certain updates in previous years

Penderworth commented 1 year ago

A few suggestions here and there, but otherwise looking great. Thanks for the overhaul! 😘

Thank you! I'm going to have my team look over the edits as well before we merge :)

black-bryan commented 1 year ago

Added one more ReadMe.md for the new beta deployment, Azure Container Apps. Would love for you to include this one in your review as well.

Penderworth commented 1 year ago

@black-bryan Thanks for bringing that up! This MR doesn't cover beta deployments per Pike's request, so let's leave that one for now. I'd like to get this merged rather than expanding its scope 😄 When that one is either out of beta or needs a review, feel free to file an issue and assign it to me. I'm happy to help edit it.

scottisloud commented 1 year ago

Cannot merge due to unverified commits. Once resolved then will merge.

Penderworth commented 1 year ago

The commits in this branch weren't signed (GPG was being funky), so I opened https://github.com/1Password/scim-examples/pull/245 with squashed commits from this branch to merge it. Closing this MR to merge that one!