Skip to content

Improve README with quick start guide and examples#93

Open
moundekaranshika wants to merge 4 commits intomandiant:masterfrom
moundekaranshika:master
Open

Improve README with quick start guide and examples#93
moundekaranshika wants to merge 4 commits intomandiant:masterfrom
moundekaranshika:master

Conversation

@moundekaranshika
Copy link
Copy Markdown

Description

This PR improves the README by adding clearer usage instructions, examples, and better formatting.

Changes Made

  • Added Quick Start section
  • Included example usage and output
  • Improved flags documentation
  • Added use cases and workflow
  • Fixed formatting issues

Motivation

Helps new users and contributors quickly understand how to use GoReSym.

Impact

No code changes. Improves documentation and onboarding.

@google-cla
Copy link
Copy Markdown

google-cla bot commented Mar 30, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

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