Ask HN: How do I improve boring README page?

Re:Ask HN: How do I improve boring README page? by TeMPOraL on Monday March 22, 2021 @12:11PM (#26542802)

I see it's a specialized library. Since I don't do much Python and never worked with modern ML, it's not very illuminating to me. That's fine, as long as the page quickly makes people like me realize this project is not for them, but stays informative for the target audience.

Good job on putting a code sample early, and adding ASCIInema videos; these are somewhat illuminating even for a person like me, who doesn't know anything about the ecosystem.

Here's what I would improve:

- Fill in the "Introduction" page; right now it's empty.

- Put appropriate links under first mention of "MinIO", "mc" and "micro" - to make it that much easier for people to fill the missing context.

- Is that Python 2 or Python 3 library? Or it works on both? ASCIInema below suggests Python 3, but that's too far down. I'd put the number(s) in the first sentence anyway.

- Where do I get it from and how? What dependencies does it require?

[ Parent | on HN ]

Re:Ask HN: How do I improve boring README page? by Jugurtha on Monday March 22, 2021 @05:04PM (#26547024)

Thank you for these pointers. I agree. It's one of those tools that, if you have that problem, you know exactly why you need it.

This solves this issue: https://github.com/minio/minio-py/issues/829. MinIO is an S3 compatible object storage software. https://min.io/

Thanks again. I'll improve the documentation.

[ Parent | on HN ]

Re:Ask HN: How do I improve boring README page? by Jugurtha on Saturday March 27, 2021 @04:03PM (#26605137)

Done. Clarified a few things without going into infinite regress. Pushed the commits, the docs should auto update after the CI/CD job terminates.

Thanks for the pointers again.

[ Parent | on HN ]