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

[Feature] Minor additions to the ReadMe to improve usability #5

Open
1 of 2 tasks
zeke-emerson opened this issue Nov 17, 2023 · 0 comments
Open
1 of 2 tasks
Labels
enhancement New feature or request

Comments

@zeke-emerson
Copy link

Is this your first time submitting a feature request?

  • I have searched the existing issues, and I could not find an existing issue for this feature
  • I am requesting a straightforward extension of existing functionality

Describe the feature

It would be helpful to include the following in the ReadMe for this repository:

  1. Note that the user must run either npm run dev or utilize pnpm to spin up the project.
  2. Note that the user must press the green Index button after navigating to the localhost and then can check in the console to validate the index was created and vectors were upserted.

Describe alternatives you've considered

No response

Who will this benefit?

All people who use this repository, especially those less familiar with TypeScript.

Are you interested in contributing this feature?

Yes, if welcomed!

Anything else?

Chatted with Roie about this as well during our chat on 11/17

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant