nishiki-tech / nishiki-frontend

Nishiki is an app for tracking and sharing food inventories within groups for better pantry management.
https://nishiki.tech
MIT License
21 stars 5 forks source link

Docs: Refine `README.md` #309

Closed nick-y-ito closed 7 months ago

nick-y-ito commented 7 months ago

Overview

Refines the README.md as much as possible.

Changes

Please see the criteria section of the linked issues.

Review points

References

I was inspired by the following repositories to refine our README.md.

Notes

Assignee Checklist:

Reviewer Checklist:

nick-y-ito commented 7 months ago

@hitohata Thank you for your feedback and approval!

Do you mean something like this? In this layout, I had to delete the H1 title because it conflicts with the logo.

image
nick-y-ito commented 7 months ago

@hitohata

I was inspired by Radix UI's README.md for the top part, by the way.

[ Image Area ]
<H1>
<description>
:
nick-y-ito commented 7 months ago

@hitohata

I feel the images (not an icon) should be better placed after the title section.

https://github.com/nishiki-tech/nishiki-frontend/blob/refs/heads/docs/279-refine-readmemd/README.md

As you suggested, I have restructured the intro part! This looks nicer 😄

nick-y-ito commented 7 months ago

I have added the documentation section!

https://github.com/nishiki-tech/nishiki-frontend/blob/refs/heads/docs/279-refine-readmemd/README.md#documentation

nick-y-ito commented 7 months ago

Also added the backend members to the authors list!

https://github.com/nishiki-tech/nishiki-frontend/blob/refs/heads/docs/279-refine-readmemd/README.md#authors

nick-y-ito commented 7 months ago

@hitohata @kotaaaa @kanta1207

Thank you for taking the time for your reviews! I hope this README.md will attract many visitors 😄