A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about. It should be in the root of the project
Why should I make it?
Other developer will likely have regarding how to install and use your project and also how to collaborate with you
readme template:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | # Foobar Foobar is a PHP library for dealing with word pluralization. ## Installation Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar. ```bash pip install foobar ``` ## Usage ```PHP import foobar some text('word') # returns 'words' ``` ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. ## License [MIT](https://choosealicense.com/licenses/mit/) |
