From c13cc317fbff536f29be01197c47b35203c7100b Mon Sep 17 00:00:00 2001 From: natashalekh <86020317+natashalekh@users.noreply.github.com> Date: Fri, 19 May 2023 20:17:10 +0200 Subject: [PATCH 1/4] Update actor_readme.md Added Misa's Readme generator and mentioned possibility to embed videos --- .../get_most_of_actors/actor_readme.md | 45 +++++++++++-------- 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/sources/academy/platform/get_most_of_actors/actor_readme.md b/sources/academy/platform/get_most_of_actors/actor_readme.md index 11b9357d95..c2070790c9 100644 --- a/sources/academy/platform/get_most_of_actors/actor_readme.md +++ b/sources/academy/platform/get_most_of_actors/actor_readme.md @@ -1,36 +1,40 @@ --- title: Actor README -description: Learn how to write a comprehensive README to help users better navigate, understand and run public actors in Apify Store. +description: Learn how to write a comprehensive README to help users better navigate, understand and run public Actors in Apify Store. sidebar_position: 2 slug: /get-most-of-actors/actor-readme --- # Actor README -**Learn how to write a comprehensive README to help users better navigate, understand and run public actors in Apify Store.** +**Learn how to write a comprehensive README to help users better navigate, understand and run public Actors in Apify Store.** --- -- It should also be a "template" for developers developing new public actors so that they have a structure and guidance for writing the readmes. -- The goal is to ensure that more people will understand and run their actors. -- 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. +- It should also be a "template" for developers developing new public Actors so that they have a structure and guidance for writing the readmes. +- The goal is to ensure that more people will understand and run their Actors. +- 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. - Consider adding a video, images, and screenshots to your readme to break up the text. -- This is an example of an actor with a readme that corresponds well to the guidelines below: +- This is an example of an Actor with a readme that corresponds well to the guidelines below: - [https://apify.com/dtrungtin/airbnb-scraper](https://apify.com/dtrungtin/airbnb-scraper) - 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). - Tip no.2: if you need any quick Markdown guidance, check out [https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/) -## What should you add to your actor readme? +> +> 🦾 **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 ⬇️ +> + +## What should you add to your Actor readme? 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. -1. **What does (actor name) do?** +1. **What does (Actor name) do?** - - in 1-2 sentences describe what the actor does and what it does not do + - in 1-2 sentences describe what the Actor does and what it does not do - consider adding keywords like API, e.g. Instagram API - always have a link to the target website in this section -2. **Why use (actor name)? or Why scrape (target site)?** +2. **Why use (Actor name)? or Why scrape (target site)?** - How it can be beneficial for the user - Business use cases @@ -45,13 +49,16 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t > ## How much will it cost me to scrape Google Maps reviews? > >
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! - >
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! + >
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! 4. **How to scrape (target site)** - Link to "How to…" blogs, if one exists (or suggest one if it doesn't) - - Add a video tutorial or gif from an ideal actor run. - - 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. + + - Add a video tutorial or gif from an ideal Actor run. + > 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. + + - 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. ![How to scrape a website - numbered tutorial](./images/how-to-scrape-target-site.webp) @@ -63,20 +70,22 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t 6. **Input** - - 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. + - 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. - This is an example of how to refer to the input tab: > Twitter Scraper has the following input options. Click on the [input tab](https://apify.com/vdrmota/twitter-scraper/input-schema) for more information. 7. **Output** - - Mention "You can download the dataset extracted by (actor name) in various formats such as JSON, HTML, CSV, or Excel.” + - Mention "You can download the dataset extracted by (Actor name) in various formats such as JSON, HTML, CSV, or Excel.” - 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) 8. **Tips or Advanced options section** - - 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. + - 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. + +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. +
-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. [Build a Stunning README For Your GitHub Profile](https://towardsdatascience.com/build-a-stunning-readme-for-your-github-profile-9b80434fe5d7) @@ -84,4 +93,4 @@ If you want some general tips on how to make GitHub readmes that stand out, chec ## Next up {#next} -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! +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! From 41b424fb998d5457430fa9b2eed1ca20ca6c920e Mon Sep 17 00:00:00 2001 From: natashalekh <86020317+natashalekh@users.noreply.github.com> Date: Tue, 23 May 2023 14:08:40 +0200 Subject: [PATCH 2/4] Update actor_readme.md All readmes in CAPS --- .../platform/get_most_of_actors/actor_readme.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/sources/academy/platform/get_most_of_actors/actor_readme.md b/sources/academy/platform/get_most_of_actors/actor_readme.md index c2070790c9..0ef1da1b07 100644 --- a/sources/academy/platform/get_most_of_actors/actor_readme.md +++ b/sources/academy/platform/get_most_of_actors/actor_readme.md @@ -11,20 +11,20 @@ slug: /get-most-of-actors/actor-readme --- -- It should also be a "template" for developers developing new public Actors so that they have a structure and guidance for writing the readmes. +- It should also be a "template" for developers developing new public Actors so that they have a structure and guidance for writing the README. - The goal is to ensure that more people will understand and run their Actors. - 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. -- Consider adding a video, images, and screenshots to your readme to break up the text. -- This is an example of an Actor with a readme that corresponds well to the guidelines below: +- Consider adding a video, images, and screenshots to your README to break up the text. +- This is an example of an Actor with a README that corresponds well to the guidelines below: - [https://apify.com/dtrungtin/airbnb-scraper](https://apify.com/dtrungtin/airbnb-scraper) -- 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). +- 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). - Tip no.2: if you need any quick Markdown guidance, check out [https://www.markdownguide.org/cheat-sheet/](https://www.markdownguide.org/cheat-sheet/) > -> 🦾 **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 ⬇️ +> 🦾 **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 ⬇️ > -## What should you add to your Actor readme? +## What should you add to your Actor README? 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. @@ -55,7 +55,7 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t - Link to "How to…" blogs, if one exists (or suggest one if it doesn't) - - Add a video tutorial or gif from an ideal Actor run. + - Add a video tutorial or GIF from an ideal Actor run. > 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. - 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. @@ -83,7 +83,7 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t 8. **Tips or Advanced options section** - 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. -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. +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.
From 17d24c912ab2e411113a8f09c3b2ac58f1012aa3 Mon Sep 17 00:00:00 2001 From: Misha Date: Tue, 23 May 2023 13:37:48 +0100 Subject: [PATCH 3/4] Fix lint error --- sources/academy/platform/get_most_of_actors/actor_readme.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sources/academy/platform/get_most_of_actors/actor_readme.md b/sources/academy/platform/get_most_of_actors/actor_readme.md index 0ef1da1b07..79a5bfc77d 100644 --- a/sources/academy/platform/get_most_of_actors/actor_readme.md +++ b/sources/academy/platform/get_most_of_actors/actor_readme.md @@ -54,8 +54,9 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t 4. **How to scrape (target site)** - Link to "How to…" blogs, if one exists (or suggest one if it doesn't) - + - Add a video tutorial or GIF from an ideal Actor run. + > 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. - 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. From f2ce3540af4f01e52ff0ff793580c145013a9da4 Mon Sep 17 00:00:00 2001 From: Misha Date: Tue, 23 May 2023 13:55:55 +0100 Subject: [PATCH 4/4] fix: fix unclosed tag --- sources/academy/platform/get_most_of_actors/actor_readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sources/academy/platform/get_most_of_actors/actor_readme.md b/sources/academy/platform/get_most_of_actors/actor_readme.md index 79a5bfc77d..816b4a1500 100644 --- a/sources/academy/platform/get_most_of_actors/actor_readme.md +++ b/sources/academy/platform/get_most_of_actors/actor_readme.md @@ -85,8 +85,8 @@ Aim for sections 1-6 below and try to include at least 300 words. You can move t - 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. 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. -
+
[Build a Stunning README For Your GitHub Profile](https://towardsdatascience.com/build-a-stunning-readme-for-your-github-profile-9b80434fe5d7)