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 #76

Closed
wants to merge 3 commits into from
Closed

Update README #76

wants to merge 3 commits into from

Conversation

vivitt
Copy link
Collaborator

@vivitt vivitt commented Apr 16, 2024

Description

Update the main README file of the project, so we have a custom description covering the main functionality of our app.

Additionally, update the README.md in the api folder, with the documentation for the updateItem, deleteItem and deleteList functions.

Type of Changes

Type
🎨 Enhancement
📝 Documentation Update

Testing Steps / QA Criteria

To test the changes locally you can install the GitHub CLI and gh pr checkout 76

Or pull the update-readme branch from my fork by adding a new remote
git remote add viviana git@github.com:vivitt/tcl-71-smart-shopping-list.git
git checkout -b update-readme
git pull viviana update-readme

Optionally you can also view the README.md file and the firebase's README in GitHub

Copy link
Collaborator

@BikeMouse BikeMouse left a comment

Choose a reason for hiding this comment

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

Well done! Thank you for this!

Add Despiensa app title, details and main features with screenshots.
Copy link
Collaborator

@borjaMarti borjaMarti left a comment

Choose a reason for hiding this comment

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

The new README looks fantastic @vivitt!! Great job, thank you! 🥳

@vivitt vivitt self-assigned this Apr 18, 2024
@vivitt vivitt closed this Apr 30, 2024
@vivitt vivitt deleted the update-readme branch April 30, 2024 16:43
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.

3 participants