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

Update README.md with SwiftShop information #91

Merged
merged 2 commits into from
Apr 7, 2024
Merged

Conversation

amandaguan-ag
Copy link
Collaborator

Type of Changes

Type
βœ“ πŸ“ Documentation update

Acceptance Criteria

  • Updated the README.md to enhance clarity and provide better context for the app's features, technology stack, and setup instructions.
  • Included detailed descriptions of new features and updates.
  • Added developer and contributor sections to acknowledge the team's effort and provide contact information.

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

  • From your terminal, pull down this branch with git pull origin ag-readme and check that branch out with git checkout ag-readme.
  • Open the README.md in your preferred markdown editor/viewer to see the changes.
  • Verify that all links are working correctly and lead to the expected pages or resources.
  • Ensure the setup instructions are clear and that you can follow them to set up the project locally.

Copy link

github-actions bot commented Apr 6, 2024

Visit the preview URL for this PR (updated for commit daa501f):

https://tcl-70-smart-shopping-list--pr91-ag-readme-5o9nbpxh.web.app

(expires Sat, 13 Apr 2024 21:24:05 GMT)

πŸ”₯ via Firebase Hosting GitHub Action 🌎

Sign: 7bb526f3a6607712c7f73ffd6c0dfff4c62b86d9

@amandaguan-ag amandaguan-ag merged commit 5d7fa2b into main Apr 7, 2024
2 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.

None yet

1 participant