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

README updates #19

Merged
merged 2 commits into from
Oct 24, 2023
Merged

README updates #19

merged 2 commits into from
Oct 24, 2023

Conversation

nicolewhite
Copy link
Contributor

No description provided.

@vercel
Copy link

vercel bot commented Oct 24, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
autoblocks-examples ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 24, 2023 1:18pm

@review-agent-prime
Copy link

The changes in the PR look good overall. However, there are a couple of minor improvements that could be made:

  1. In the "Getting started" section, the .env file creation instructions could be made clearer. Instead of having the filename .env on a new line, it would be more readable to include it in the sentence.
- Create a `.env` file at the root of this repository with the following environment variables
+ Create a file named `.env` at the root of this repository and include the following environment variables
  1. In the "JavaScript" section, the note about the requirements could be made more readable by removing the backticks around node >= 16.
- All JavaScript examples require `npm` and `node >= 16` to be installed.
+ All JavaScript examples require `npm` and node version 16 or higher to be installed.

These changes should make the instructions more clear and easier to follow.

@nicolewhite nicolewhite merged commit b70185c into main Oct 24, 2023
9 checks passed
@nicolewhite nicolewhite deleted the update-main-readme branch October 24, 2023 15:52
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.

2 participants