I am currently writing cert-auth security docs at work, so I am really excited to see an OS project in the same domain.
I second Ben's suggestions of revisiting the README once a month as well as adding a high-level description of REMME Core. A few additional thoughts:
It might be helpful to have a link to the explainer video (youtube.com/watch?v=9APHeHRmrGw). The video will help set the context and orient the user by explaining the end-problem that REMME aims to solve.
The next logical step is a brief overview of the architecture of the product and where/how Core fits into it.
Then a brief overview of Core's architecture/design would be helpful, followed by a list of features in dev and opportunities for contributions.
Then move on to the tactical part: a section for prerequisites that has a bullet list of requirements (macOS, Linux, Docker, etc.)
I am unsure of what the "For end-users" section refers to. My instinct tells me this is the installation section that developers and contributors could benefit from as well (they could try out the product from the user's perspective before figuring out how/what to contribute). If yes, the section could be renamed as "Install REMME Core". (I am utterly confused by how Core could be installed as a stand-alone application and how it fits into the rest of the components, but I attribute this confusion to my lack of technical know-how of this project).
This could be followed by the "For developers and contributors" section.
I am also curious to know how to use the product as a user. I parsed through the publicly available marketing and dev docs, but couldn't make the logical jump from the explainer video to the articles in the knowledge base. Is there a Getting Started guide that I failed to locate?
It was great tips. I collected them and included in upcoming changes. But here it is some changes that could be quickly implemented: github.com/Remmeauth/remme-core/is...
What do you think? Does that make our protocol more accessible? Maybe you can leave your comment directly in GitHub, so our contributors see them as well. I appreciate your help!
I am currently writing cert-auth security docs at work, so I am really excited to see an OS project in the same domain.
I second Ben's suggestions of revisiting the README once a month as well as adding a high-level description of REMME Core. A few additional thoughts:
I am also curious to know how to use the product as a user. I parsed through the publicly available marketing and dev docs, but couldn't make the logical jump from the explainer video to the articles in the knowledge base. Is there a Getting Started guide that I failed to locate?
It was great tips. I collected them and included in upcoming changes. But here it is some changes that could be quickly implemented: github.com/Remmeauth/remme-core/is...
What do you think? Does that make our protocol more accessible? Maybe you can leave your comment directly in GitHub, so our contributors see them as well. I appreciate your help!
Oooh..it's so much clearer now! Left a few additional comments on the GitHub issue :)