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

Updated README to be more precise. Provided context about Amplify in README. #3638

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

nithinbandaru1
Copy link

Issue #, if available: #3637

Description of changes:

Problem Statement

  • Currently README starts with providing Migration Guide for Amplify V2, which can be mis-interpreted as if this Repo is Amplify itself and sounds like new version of Amplify is released which is breaking change and here it is pointing to migration guide.
  • I am not sure about how many people will get confused with this and raise questions like here.
  • I am a new developer trying to create Android app for AWS services and this will make a good case to see this problem and PR reasonable to avoid unnecessary questions from beginners.
  • It also looks like this not the recommended one for new app development, though it is not deprecated now, it is unlikely that this will be added/updated with new features from AWS making it one more reason to be more precise about it in README.

Solution

  • Changed it to markdown Blockquotes format to show separation from Amplify and this repo.
  • Added info on what is Amplify library actually and it is recommended one.
  • Added info saying that this repo will be updated with security and bug fixes.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

…readme

Updated README to be more precise.
Provided context about Amplify in README.
@nithinbandaru1 nithinbandaru1 requested a review from a team as a code owner September 11, 2024 03:52
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