Skip to content

Update the README #8

@ad4rsh2701

Description

@ad4rsh2701

Only After #6 (Create a CONTRIBUTING.md file), you shall touch this issue.

The current README was made in agony, most likely, I do not remember, but we need a better front facing homepage to give much better idea about RiRi.

So, rewrite the README.md, and it should:

  • Represent what RiRi actually is
  • The roadmap (don't call it roadmap though, we can think of a better name).
  • It's expected benefits (I know we can't give benchmarks yet, but giving use case scenarios may help)
  • Future of RiRi
  • Using RiRi - A theoretical guide as to how RiRi will be used (Good luck with this, may coffee help you).
  • Building Riri - Also a theoretical guide (I am so sorry, but you have got to use cmake this time, just use it, skip daily commit goal, if it helps).
  • Future expansion: Give notes on what AFTER the basic stuff, client-server, those security stuff (yes, we omitted that, but the entire identity of RiRi is, simple, fast, efficient and secure), give briefing on the variant of E2EEE you are going to use (Fourier series to add complexity).
  • And of course, some FAQs to clear confusion.
  • Do thank the reader, you aren't getting any anyways.
  • Add anything a typical readme DOESN'T have, and also those which a typical readme does have, but better

Have fun, cry, scream, etc.
I know this is the most hated part, but also the most important.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions