When you are writing a script or a mod, it is important to include some additional information about the files. This tells the user more about the files they are installing, as well as who wrote them and how to use them. Depending on your script this could be included in a separate file for reference, in the install file, or commented out in the PHP file itself. Some things you may wish to included are:
- Title - What is your script or mod called
- Author - You name, and the name of anyone who helped or who's work you modified
- Version - What version of the script is this? 1.0? 2.3? etc....
- Installation Time - An idea of how long it will take the user to be up and running.
- Included Files / Edited Files - This is a list of files that are part of your script, and in the case of a mod, files that will need to be edited.
- Licensing - Make sure it's clear how the user may and may not use your script.
- History - History of the mod including the change log of all previous versions.
- Other Notes - Any other information you want to include about your script, including your support website (if you have one) or other information that may be useful
