search

saket / telephoto

Building blocks for designing media experiences in Compose UI
https://saket.github.io/telephoto/
Apache License 2.0
872 stars 29 forks source link

Update and rename readme.md to README.md #24

Closed imranaai closed 1 year ago

imranaai commented 1 year ago

What I changed:


+ Renamed the readme.md file to `README.md` for better visibility. 
+ Improvement in the License Section of the `README.md` file. 
+ Added `©` for better visibility of copyright.
saket commented 1 year ago

Is this a duplicate of https://github.com/saket/telephoto/pull/23?

imranaai commented 1 year ago

Is this a duplicate of https://github.com/saket/telephoto/pull/23?

Yes, First by convention it is always in all caps, Due to the human behaviour by which we always look for familiar objects, And since most of the repositories have the README file all caps, thus it will be more easier to find this file.

imranaai commented 1 year ago

Yes it could be a duplicate, since I am new to open-source and GitHub please let me know if I have done something wrong. I am here to learn and improve.

saket commented 1 year ago

No worries and welcome!

You're right that most projects name their readme file in full caps, but AFAIK that's a holdover from the unix world where uppercase file names are listed above lowercase names by the ls command. I don't think this is needed anymore. I personally find readme.md more pleasing to my eyes. 🙂

imranaai commented 1 year ago

No worries and welcome!

You're right that most projects name their readme file in full caps, but AFAIK that's a holdover from the unix world where uppercase file names are listed above lowercase names by the ls command. I don't think this is needed anymore. I personally find readme.md more pleasing to my eyes. 🙂

Yes thanks! that's something I learned today about unix. Otherwise you could have merged the part where I changed the License section to make it look better according to me. Well you can let me know about your thoughts on the change in License section.