Enhance Synopsis in README for Better Understanding.

tenderlove / rails_autolink

The auto_link function from Rails

MIT License

588 stars 91 forks source link

Enhance Synopsis in README for Better Understanding. #86

Closed hirano-vm4 closed 1 year ago

hirano-vm4 commented 1 year ago

Proposal

Thank you for providing this fantastic gem.

To make it easier for programming beginners to understand the benefits of this gem, I would like to enhance the Synopsis.

Currently, it only includes code and execution results. In addition to that, I would like to add a simple explanation that allows users to grasp the functionality of rails_autolink quickly.

hirano-vm4 commented 1 year ago

@ramhoj @amatsuda

Thank you for the wonderful gem.

What do you think of the README suggestion?