Skip to content

Current project capabilities not clear in README #13

Description

@jenniferlieu

Sorry to nitpick ya'll but there are no issues that I found other than this.

Issue:
Current project expectations and capabilities not stated in the README

What I did:
I read the README and went to the website.

Perspective on the issue:
As a user, I would have to rely solely on the README to understand how the project works. If Ben hadn't done a demo and explained in class what part of the project works or doesn't work, I would be confused/disappointed as to why the website/app wasn't working as I expected according to the description/vision of the completed project.

Suggested solution:
So, a suggested solution is to add a little bit of a "disclaimer" or something along those lines about what the project is currently capable of in order to set an expectation for the users.

System:
OS: Mac Catalina (10.15.7)
Browser: Safari v15

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions