README file improvement.

Open Beginner friendly
#66 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Open README.md and read the usage section around point 4, then compare its wording with the command handling in the code. Done means the README includes an example showing that the command expects a file name without a relative path or file format.

Written by the indexing model from the issue text.

Description

Just a quick fix.

There is a message in the usage section of the README.md file.

Screenshot 2023-12-26 at 2 00 04 AM

This statement (point 4 in the above image) does not specify what file name variation is expected, when looking at the code it is clear that only file name is expected without a relative path and format.

My suggestion is to include an example that clarifies the way the file name is expected in command

Dominant language
TypeScript
Stars
120
Forks
124
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from gitdagray/csv-to-sql-insert

All issues in gitdagray/csv-to-sql-insert

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.