Improve README for mainnet

Joystream / joystream

Joystream Monorepo

http://www.joystream.org

GNU General Public License v3.0

1.42k stars 115 forks source link

Open bedeho opened 2 years ago

bedeho commented 2 years ago

WIP.

Note: def. ask for design help!

┆Issue is synchronized with this Asana task by Unito

mochet commented 2 years ago

Some basic ideas/suggestions:

Doesn't have any logo etc
Doesn't explain what the project actually is
Links to other critical repos (Pioneer/Atlas) aren't very prominent
No descriptions of what each component does
Some links to other documentation etc seems missing (handbook link seems like it is needed)

bedeho commented 2 years ago

Perhaps you could add a list of other really solid project README files for other solid projects?

mochet commented 2 years ago

(WIP - adding things that I come across)

You can apparently add a README.md to the organization landing page as shown here: https://github.com/casimir-ai
You can also add a thumbnail somehow that shows up in search results like this repo has: https://github.com/paritytech/ink (it can also be animated). This would help with visibility within GitHub itself.