Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

misc updates to the repo readme #34

Merged
merged 2 commits into from
May 20, 2024
Merged

Conversation

devoncarew
Copy link
Collaborator

@devoncarew devoncarew commented May 14, 2024

Description

Misc updates to the repo readme:

  • use the latest published package versions in the packages table
  • comment out a todo
  • switch to using emojis instead of images

Related Issues

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).
This will ensure a smooth and quick review process. Updating the pubspec.yaml and changelogs is not required.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (melos run analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • Yes, this is a breaking change.
  • No, this is not a breaking change.

@devoncarew
Copy link
Collaborator Author

cc @craiglabenz

@devoncarew
Copy link
Collaborator Author

Screenshot 2024-05-14 at 9 37 27 AM

<td align="center"><img height="16" width="16" src="https://raw.githubusercontent.com/google/flutter-mediapipe/main/assets/no.png"/></td>
<td align="center">✅</td>
<td align="center">✅</td>
<td align="center">-</td>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does a red emoji make sense here instead of a single dash?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tend to think of an unfilled square as more 'missing' rather than an error state, but this is your readme :) I can try that out something like ❌ or ✖.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm, that's a good point. We can go with -.

| [mediapipe_core](packages/mediapipe-core/) | Shared logic and utilities required by other MediaPipe Task packages. | 0.0.1 |
| [mediapipe_text](packages/mediapipe-task-text/) | An implementation of the MediaPipe Text APIs | 0.0.1 |
| [mediapipe_genai](packages/mediapipe-task-genai/) | An implementation of the MediaPipe GenAI APIs | 0.0.1 |
| [mediapipe_core](packages/mediapipe-core/) | Shared logic and utilities required by other MediaPipe Task packages. | ![pub package](https://img.shields.io/pub/v/mediapipe_core) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh right, duh!

@devoncarew
Copy link
Collaborator Author

Thanks for the review! FYI that I'm unable to land this PR myself.

@craiglabenz craiglabenz merged commit 8cc5e3f into google:main May 20, 2024
3 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.

2 participants