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

fix: update README to correct cloning instructions for Node.js Hello World and Express example #1

Closed
wants to merge 2 commits into from

Conversation

developerjhp
Copy link
Owner

The previous README instructions for cloning the repository were incorrect, as Git does not support cloning a specific subdirectory. This update modifies the instructions to:

  • Clone the entire repository.
  • Navigate to the specific example directory.
  • Ensure the process is clear for users to deploy the Node.js Hello World or express example using Vercel CLI.

This change addresses the issue reported in vercel#992.

Description

The previous README contained incorrect instructions for cloning the repository. This PR updates the instructions to:

  • Clone the entire repository instead of attempting to clone a specific subdirectory.
  • Provide steps to navigate to the desired example directory.
  • Improve clarity for deploying the example using the Vercel CLI.

This change ensures users can successfully follow the README to deploy the Node.js Hello World example.

Demo URL

Not applicable for this change as it only involves documentation updates.
However, the steps in the README were tested locally to ensure correctness.

The previous README instructions for cloning the repository were incorrect, as Git does not support cloning a specific subdirectory. 
This update modifies the instructions to:
- Clone the entire repository.
- Navigate to the specific example directory.
- Ensure the process is clear for users to deploy the Node.js Hello World example using Vercel CLI.
The previous README for the express example contained incorrect instructions for cloning the repository by attempting to clone a subdirectory, which is not supported by Git. This update modifies the README to:

- Guide users to clone the entire repository and navigate to the correct example directory.
@developerjhp developerjhp self-assigned this Dec 26, 2024
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.

1 participant