Explain how your function works.

Writing a README is essential to writing good software. In Function Store, it is required to have a file in your function. Here you have some reasons to create a good one:

  • It's the first item a user/client will see when visiting your function.

  • It contains information that is commonly required to understand what the function is about.

  • It's an easy way to answer the questions your audience is likely to have about how to install and use your function.

While READMEs can be written in any text file format, the most common one in use today is Markdown. You must use Markdown to write the README info of the function, and the file name should be uppercase so that it is more prominent.

Check the Document your Functions and Editorial guidelines pages to learn more.

Last updated