header-logo
Learn how to use Wix to build your site and business.
Design and manage your site using intuitive Wix features.
Manage subscriptions, plans and invoices.
Run your business and connect with members.
Learn to purchase, connect or transfer a domain to your site.
Get tools to grow your business and web presence.
Boost your visibility with SEO and marketing tools.
Get advanced features to help you work more efficiently.
Find solutions, learn about known issues or contact us.
placeholder-preview-image
Improve your skills with our courses and tutorials.
Get tips for web design, marketing and more.
Learn to increase organic site traffic from search engines.
Build a custom site using our full-stack platform.
Get matched with a specialist to help you reach your goals.
placeholder-preview-image

Documenting Your Velo Package

1 min
All Wix users can create Velo Packages. To create apps for Wix sites with the full version of Wix Blocks, join Wix Studio.
Wix Blocks provides an empty readme.md markdown file for you to edit as part of the package creation process. Edit the file to provide documentation for your package users. 
  1. Click  README.md in the code files panel README section.
  1. Write your text in the markdown file provided.
  2. Click Preview to see how the file is rendered.

Readme contents

Your readme should include the following sections:
  • An introduction that explains what the package does and why it's useful.
  • How to use the package
  • Package contents and functions provided.
  • Packages, such as npm packages, included in your package, along with licensing information for those packages. For example, your users should be aware that when they install a package that uses an npm package, they agree to that npm package's license agreement.
  • Instructions for using the package's functions.
  • Usage examples.