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.
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
anddeleteList
functions.Type of Changes
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