The README.md
file contains a documentation what your actor does and how to use it,
which is then displayed in the app or Apify Store. It's always a good
idea to write a good README.md
, in a few months not even you
will remember all the details about the actor.
You can use Markdown language for rich formatting.
See our tutorial on writing READMEs for your actors if you need more inspiration.
If your README requires a table of contents, use the template below and make sure to keep the <!-- toc start -->
and <!-- toc end -->
markers.
- Introduction
- Use Cases
- Case 1
- Case 2
- Input
- Output
- Miscellaneous