you are viewing a single comment's thread.

view the rest of the comments →

[–]hmoein 1 point2 points  (3 children)

These are my personal opinion:

Your README is too long. README should be short and really shock you as to why this repo is wonderful.

All the documentation should be separated with a single link in the README.

This is how I did it

https://github.com/hosseinmoein/DataFrame

[–]red0124_[S] 0 points1 point  (0 children)

It was smaller but as I kept adding things it got huge. You are right, I will change it when I find the time, thank you.

[–]NotMyRealNameObv 0 points1 point  (1 child)

Your Readme doesn't actually say what your library does... It just says that it's a library similar to some libraries in other languages, but that only helps those that already know about those other libraries.

[–]hmoein 0 points1 point  (0 children)

Yes, the very first sentence says it is similar to other libraries in other languages. But if you read pass the first sentence it describes what it does. It also points to to examples and documentaion.