1Password / connect-sdk-python

Python SDK for 1Password Connect
https://developer.1password.com/docs/connect
MIT License
200 stars 30 forks source link

Enhance README and move usage content to USAGE.md #74

Closed edif2008 closed 1 year ago

edif2008 commented 1 year ago

This PR contains the following key changes:

How to review this PR

  1. Check the new README page by clicking this link.
    • [ ] The new template is used properly.
    • [ ] The Get started page contains enough informations to give an overview of common things that users can do with the SDK. Make sure that it doesn't feel like there's too little content.
    • [ ] See it in action - is it useful?
  2. Check the old README by clicking this link.
    • [ ] Content was properly migrated to the new files.
    • [ ] Is there anything that was cut out and should be brought back in?
  3. Check the USAGE.md page by clicking this link.
    • [ ] Flow of documentation is clean and clear.
    • [ ] Can easily find the content needed to achieve your goal.
    • [ ] Code snippets actually work.
codecov-commenter commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (27915c3) 76.11% compared to head (5384e6d) 76.11%.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #74 +/- ## ======================================= Coverage 76.11% 76.11% ======================================= Files 21 21 Lines 1587 1587 ======================================= Hits 1208 1208 Misses 379 379 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

jillianwilson commented 1 year ago

Just a reminder to update the repo link to point to the connect overview page in the dev portal :)