Getting started with Apify actors

The README.md file documents what your actor does and how to use it, which is then displayed in the Console or Apify Store. It's always a good idea to write a 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.

Documentation reference

• Apify SDK
• Crawlee
• Apify Actor documentation
• Apify CLI

Writing a README

See our tutorial on writing READMEs for your actors if you need more inspiration.