Update README.md with SwiftShop information #91
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Type of Changes
Acceptance Criteria
Description
This PR updates the README file to better reflect the current state of our project, SwiftShop. The update includes a more detailed description of SwiftShop's features, a comprehensive guide on how to get started with the app, an updated list of technologies used, and a section dedicated to the developers and contributors behind the project.
Enhanced Feature Descriptions
We've added more detailed explanations of SwiftShop's key features, including its smart shopping list capabilities, user-friendly design, and focus on accessibility. This section aims to provide potential users and contributors with a clear understanding of what makes SwiftShop stand out.
Updated Setup Instructions
The README now contains updated setup instructions that are easier to follow, ensuring that new contributors can get the project up and running on their local machines without any confusion. This includes step-by-step commands for cloning the repository, installing dependencies, and starting the app.
Technologies Section
We've provided a detailed list of the technologies, libraries, and frameworks used in the development of SwiftShop. Each technology is accompanied by a brief description and, where applicable, links to official documentation or resources for further reading.
Developer and Contributor Recognition
A new section has been added to recognize the efforts of the development team and contributors. This section includes links to LinkedIn and GitHub profiles, offering an opportunity for community engagement and networking.
Testing Steps / QA Criteria
git pull origin ag-readme
and check that branch out withgit checkout ag-readme
.