Skip to content

docs: Improve and modernize README#958

Open
vdusek wants to merge 7 commits into
masterfrom
docs/polish-readme
Open

docs: Improve and modernize README#958
vdusek wants to merge 7 commits into
masterfrom
docs/polish-readme

Conversation

@vdusek

@vdusek vdusek commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Polishes and modernizes the README, mirroring the recent apify-client-python polish (apify/apify-client-python#776).

  • Reworked intro and badge row (added a CI build-status badge), plus a table of contents.
  • Reordered sections, with a new What are Actors? up front and a What you can build section (scraping, browser automation, AI agents, MCP servers, web servers).
  • Added Documentation, Related projects, Support and community, and Contributing sections.

@vdusek vdusek added adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team. labels Jun 10, 2026
@vdusek vdusek self-assigned this Jun 10, 2026
@github-actions github-actions Bot added this to the 142nd sprint - Tooling team milestone Jun 10, 2026
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.00%. Comparing base (a87e8d1) to head (48d7273).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #958   +/-   ##
=======================================
  Coverage   90.00%   90.00%           
=======================================
  Files          49       49           
  Lines        3053     3053           
=======================================
  Hits         2748     2748           
  Misses        305      305           
Flag Coverage Δ
e2e 35.66% <ø> (ø)
integration 56.86% <ø> (ø)
unit 78.70% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@vdusek vdusek changed the title docs: polish and modernize README docs: Improve and modernize README Jun 11, 2026
@vdusek vdusek marked this pull request as ready for review June 11, 2026 11:21
@vdusek vdusek requested review from Pijukatel and szaganek June 11, 2026 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants