Writing a README can be difficult for developers, especially after spending a long time developing their actor. However, it is the first page users will see when they try to use your actor. Its job is to attract the users' attention and describe to them what the actor does and how to use it. Thus, the complexity of the README should match the complexity of the actor. The following article provides an example of how to write a README for your actor.
The README is written in the README.md file in your actor's repository. From there, it is automatically fetched during the build process.
- Use Cases
First things first: to make your actor easy to find, don't forget to word your actor's title as we describe in the SEO for Actors article. Be sure to also use these principles in your actor's description and throughout the README.md file. You don't need to repeat your actor's README in the description - instead use it to provide a brief, search engine friendly summary.
A detailed TEXT description of what your actor can do and why you developed it.
LIST typical scenarios in which your actor can be useful. Include information on how exactly your actor can be used in these cases.
LIST all possible inputs for your actor. Do not go into the complete technical description - you can explain this in your actor's Input Schema.
CODE example of one of your results in JSON format. For brevity, only provide a snapshot of the actor's output. For real-time examples, add a Public run ID in your actor's Publication tab.
A short TEXT summary including some specific notes on your actor. Additionally, include links to tutorials and other relevant sources.
A few examples
- Web Scraper (apify/web-scraper) is an advanced actor with a detailed README
- Instagram Scraper (apify/instagram-scraper) is a medium complexity actor
- Google Search Results Scraper (apify/google-search-scraper) is a medium complexity actor
- Amazon Best Sellers Scraper (apify/amazon-bestsellers-scraper) is a basic actor with a simple README