Skip to content

Commit 3f67b8e

Browse files
feat: update actor_readme.md (#592)
Added Misa's Readme generator and mentioned possibility to embed videos --------- Co-authored-by: Misha <m.murasovs@gmail.com>
1 parent 84086cf commit 3f67b8e

File tree

1 file changed

+30
-20
lines changed

1 file changed

+30
-20
lines changed
Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,40 @@
11
---
22
title: Actor README
3-
description: Learn how to write a comprehensive README to help users better navigate, understand and run public actors in Apify Store.
3+
description: Learn how to write a comprehensive README to help users better navigate, understand and run public Actors in Apify Store.
44
sidebar_position: 2
55
slug: /get-most-of-actors/actor-readme
66
---
77

88
# Actor README
99

10-
**Learn how to write a comprehensive README to help users better navigate, understand and run public actors in Apify Store.**
10+
**Learn how to write a comprehensive README to help users better navigate, understand and run public Actors in Apify Store.**
1111

1212
---
1313

14-
- It should also be a "template" for developers developing new public actors so that they have a structure and guidance for writing the readmes.
15-
- The goal is to ensure that more people will understand and run their actors.
16-
- Whenever you build an actor, think of the original request/idea and the "use case" = "user need" it should solve, please take notes and share them with Apify, so we can help you write a blog post supporting your actor with more information, more detailed explanation, better SEO.
17-
- Consider adding a video, images, and screenshots to your readme to break up the text.
18-
- This is an example of an actor with a readme that corresponds well to the guidelines below:
14+
- It should also be a "template" for developers developing new public Actors so that they have a structure and guidance for writing the README.
15+
- The goal is to ensure that more people will understand and run their Actors.
16+
- Whenever you build an Actor, think of the original request/idea and the "use case" = "user need" it should solve, please take notes and share them with Apify, so we can help you write a blog post supporting your Actor with more information, more detailed explanation, better SEO.
17+
- Consider adding a video, images, and screenshots to your README to break up the text.
18+
- This is an example of an Actor with a README that corresponds well to the guidelines below:
1919
- [https://apify.com/dtrungtin/airbnb-scraper](https://apify.com/dtrungtin/airbnb-scraper)
20-
- Tip no.1: if you want to add snippets of code anywhere in your readme, you can use [Carbon](https://github.com/carbon-app/carbon).
20+
- Tip no.1: if you want to add snippets of code anywhere in your README, you can use [Carbon](https://github.com/carbon-app/carbon).
2121
- Tip no.2: if you need any quick Markdown guidance, check out [https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/)
2222

23-
## What should you add to your actor readme?
23+
>
24+
> 🦾 **No time for writing?** Our [README Generator](https://apify.com/apify/actor-readme-generator) will create a new README out of thin air following the template below ⬇️
25+
>
26+
27+
## What should you add to your Actor README?
2428

2529
Aim for sections 1-6 below and try to include at least 300 words. You can move the sections around to some extent if it makes sense, e.g. 3 might come after 6. Consider using emojis as bullet points or otherwise trying to break up the text.
2630

27-
1. **What does (actor name) do?**
31+
1. **What does (Actor name) do?**
2832

29-
- in 1-2 sentences describe what the actor does and what it does not do
33+
- in 1-2 sentences describe what the Actor does and what it does not do
3034
- consider adding keywords like API, e.g. Instagram API
3135
- always have a link to the target website in this section
3236

33-
2. **Why use (actor name)? or Why scrape (target site)?**
37+
2. **Why use (Actor name)? or Why scrape (target site)?**
3438

3539
- How it can be beneficial for the user
3640
- Business use cases
@@ -45,13 +49,17 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t
4549
> ## How much will it cost me to scrape Google Maps reviews?
4650
>
4751
> <br/> Apify provides you with $5 free usage credits to use every month on the Apify Free plan and you can get up to 100,000 reviews from this Google Maps Reviews Scraper for those credits. So 100k results will be completely free!
48-
> <br/> But if you need to get more data or to get your data regularly you should grab an Apify subscription. We recommend our $49/month Personal plan - you can get up to 1 million Google Maps reviews every month with the $49 monthly plan! Or 10 million with the $499 Team plan - wow!
52+
> <br/> But if you need to get more data or to get your data regularly you should grab an Apify subscription. We recommend our $49/month Starter plan - you can get up to 1 million Google Maps reviews every month with the $49 monthly plan! Or 10 million with the $499 Scale plan - wow!
4953
5054
4. **How to scrape (target site)**
5155

5256
- Link to "How to…" blogs, if one exists (or suggest one if it doesn't)
53-
- Add a video tutorial or gif from an ideal actor run.
54-
- Consider adding a short numbered tutorial as Google will sometimes pick these up as rich snippets. Remember that this might be in search results, so you can repeat the name of the actor and give a link, e.g.
57+
58+
- Add a video tutorial or GIF from an ideal Actor run.
59+
60+
> Tip: For better user experience, Apify Console automatically renders every YouTube URL as an embedded video player. Simply add a separate line with the URL of your YouTube video.
61+
62+
- Consider adding a short numbered tutorial as Google will sometimes pick these up as rich snippets. Remember that this might be in search results, so you can repeat the name of the Actor and give a link, e.g.
5563

5664
![How to scrape a website - numbered tutorial](./images/how-to-scrape-target-site.webp)
5765

@@ -63,25 +71,27 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t
6371
6472
6. **Input**
6573

66-
- Each actor detail page has an input tab, so you just need to refer to that. If you like, you can add a screenshot showing the user what the input fields will look like.
74+
- Each Actor detail page has an input tab, so you just need to refer to that. If you like, you can add a screenshot showing the user what the input fields will look like.
6775
- This is an example of how to refer to the input tab:
6876

6977
> Twitter Scraper has the following input options. Click on the [input tab](https://apify.com/vdrmota/twitter-scraper/input-schema) for more information.
7078
7179
7. **Output**
7280

73-
- Mention "You can download the dataset extracted by (actor name) in various formats such as JSON, HTML, CSV, or Excel.”
81+
- Mention "You can download the dataset extracted by (Actor name) in various formats such as JSON, HTML, CSV, or Excel.”
7482
- Add a simplified JSON dataset example, like here: [https://apify.com/drobnikj/crawler-google-places#output-example](https://apify.com/drobnikj/crawler-google-places#output-example)
7583

7684
8. **Tips or Advanced options section**
77-
- Share any tips on how to best run the actor, such as how to limit compute unit usage, get more accurate results, or improve speed.
85+
- Share any tips on how to best run the Actor, such as how to limit compute unit usage, get more accurate results, or improve speed.
86+
87+
If you want some general tips on how to make GitHub README that stand out, check out these guides. Not everything in there will be suitable for an Apify Actor README, so you should cherry-pick what you like and use your imagination.
7888

79-
If you want some general tips on how to make GitHub readmes that stand out, check out these guides. Not everything in there will be suitable for an Apify actor readme, so you should cherry-pick what you like and use your imagination.
89+
<br />
8090

8191
[Build a Stunning README For Your GitHub Profile](https://towardsdatascience.com/build-a-stunning-readme-for-your-github-profile-9b80434fe5d7)
8292

8393
[How to Create a Beautiful README for Your GitHub Profile](https://yushi95.medium.com/how-to-create-a-beautiful-readme-for-your-github-profile-36957caa711c)
8494

8595
## Next up {#next}
8696

87-
If you followed all the tips described above, your actor README should be good to go! In the [next lesson](./seo_and_promotion.md)! we will dive deeper into how you can improve your README's SEO and promote your actor to ensure it reaches as many potential users as possible!
97+
If you followed all the tips described above, your Actor README should be good to go! In the [next lesson](./seo_and_promotion.md)! we will dive deeper into how you can improve your README's SEO and promote your Actor to ensure it reaches as many potential users as possible!

0 commit comments

Comments
 (0)