search

overture-stack / ego

OAuth 2.0 authorization service that supports multiple OpenID identity providers
https://www.overture.bio/products/ego
GNU Affero General Public License v3.0
26 stars 14 forks source link

Readme Update #666

Closed MitchellShiell closed 1 year ago

MitchellShiell commented 2 years ago

Re-posting this PR, all the other main Overture readmes are drafted. I'm holding back on pulling them before getting feedback on this one. As discussed offline, I plan on cutting down the pre-amble/marketing and bringing the development setup closer to the top.

MitchellShiell commented 1 year ago

Draft 2 of Readme Update

Thanks for all the feedback, happy with the progress on this have a look and leave your thoughts.

Elements should line up correctly when viewing from repo https://github.com/MitchellShiell/ego/tree/readmeupdate

Minimized overture branding and focused on Ego

Restructured content and slimmed down the writing for better readability

Updated badges and images

I'll reiterate what you mentioned previously; An update to the Github Wiki is required:

  1. Running ego as a developer

  2. Ego configuration and run profiles

  3. Explanations of the ego data model (users, applications, groups, permissions, api-keys) and how to interact with it.

Beyond that adding on technical specifications and dependencies required within the technical specifications section