Skip to content

docs: polish and modernize README#958

Draft
vdusek wants to merge 1 commit into
masterfrom
docs/polish-readme
Draft

docs: polish and modernize README#958
vdusek wants to merge 1 commit into
masterfrom
docs/polish-readme

Conversation

@vdusek

@vdusek vdusek commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Summary

The README had fallen behind the rest of the project: a badge-only header, a four-line intro, no table of contents, and no links into the docs site, related projects, or community/contributing sections.

This rewrite follows modern OSS conventions and mirrors the recent apify-client-python README polish (apify/apify-client-python#776), adapted for the SDK:

  • Centered tagline and cleaned-up badges (added a License badge, reordered, dropped rel="nofollow").
  • Intro describing what the SDK does, plus a callout pointing API-only users to the Apify API client.
  • Table of contents.
  • Installation via pip and uv, including the scrapy extra.
  • Quick start: a minimal Actor plus a CLI scaffold-and-run procedure.
  • Features as a linked bullet list pointing into the Concepts and Guides docs.
  • Kept the HTTPX + BeautifulSoup and Crawlee Playwright usage examples and the "What are Actors?" section.
  • New Documentation table, Related projects, Support and community, Contributing, and License 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 (79bffe6).
⚠️ 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.

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