Skip to content

doc(README): update README#76

Merged
leduclean merged 2 commits into
mainfrom
doc/update-readme-for-first-release
Sep 9, 2025
Merged

doc(README): update README#76
leduclean merged 2 commits into
mainfrom
doc/update-readme-for-first-release

Conversation

@baptleduc

Copy link
Copy Markdown
Owner

No description provided.

@baptleduc baptleduc self-assigned this Sep 6, 2025
@baptleduc baptleduc linked an issue Sep 6, 2025 that may be closed by this pull request

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README to provide a more concise and user-friendly documentation structure with visual elements and simplified usage instructions.

  • Simplifies the documentation by removing detailed command arguments and options in favor of help references
  • Adds a demo GIF and contributor acknowledgments to improve visual appeal
  • Updates the installation command from cargo install replay to cargo install replay_pty

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread README.md Outdated
> Run these commands once after cloning the repository to ensure the hooks are active.
Thanks to all the people who already contributed!

<a href="https://github.com/ariel-os/ariel-os/graphs/contributors">

Copilot AI Sep 6, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The contributor link URL points to 'ariel-os/ariel-os' repository but the image source uses 'baptleduc/replay'. These should reference the same repository for consistency.

Suggested change
<a href="https://github.com/ariel-os/ariel-os/graphs/contributors">
<a href="https://github.com/baptleduc/replay/graphs/contributors">

Copilot uses AI. Check for mistakes.
@leduclean leduclean merged commit e099b13 into main Sep 9, 2025
4 checks 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.

doc: Update README for first release

3 participants