Skip to content

update the readme#17

Merged
arcursino merged 1 commit into
scanapi:mainfrom
arcursino:issue_15
Jul 8, 2026
Merged

update the readme#17
arcursino merged 1 commit into
scanapi:mainfrom
arcursino:issue_15

Conversation

@arcursino

Copy link
Copy Markdown
Member

Description

This PR updates the repository's README.md to establish a clear, structured, and welcoming documentation base for new users and contributors.

Changes Made

  • About the Project: Added a high-level overview, value proposition, and tech stack details.
  • Getting Started: Included clear prerequisites, installation steps, and local runtime instructions.
  • Contributing: Added a welcoming call-to-action for open-source collaboration and community growth.

Guidelines Enforced

  • Explicitly documented the mandatory requirement to run black src/ before committing code to ensure consistent code styling.

Checklist

  • Tested changes locally.
  • Code formatted with black src/
  • Documentation updated.

@arcursino arcursino merged commit cfe6747 into scanapi:main Jul 8, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant