Skip to content

Commit b252d32

Browse files
committed
docs: readme
1 parent c919eee commit b252d32

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Build and install the package globally so you have access in your cli terminal.
3939
1. build `npm run build:es`
4040
2. install `npm install -g .`
4141

42-
Then test the package is working and installed by calling the package name `pkg-name` in your terminal.
42+
Then test the package is working and installed by calling the package name `csv-picker` in your terminal.
4343

4444
### Testing
4545

@@ -48,3 +48,15 @@ This project uses [vitest](https://vitest.dev/) for testing.
4848
1. run the unit tests with `npm run test`
4949

5050
It's also recommended to install the [vitest extension for vscode](https://marketplace.visualstudio.com/items?itemName=ZixuanChen.vitest-explorer).
51+
52+
### vite-node
53+
54+
When running the `npm run dev` command you need to prefix any arguments with `--`
55+
56+
eg `npm run dev -- -p ./src/input.csv -o ./src/output.csv`
57+
58+
### Running the cli
59+
60+
1. The input path and output path need to be provided
61+
2. run `csv-picker --help` for a list of options
62+
3. run the cli with arguments `csv-picker -p ./src/input.csv -o ./src/output.csv` to create a sorted csv file from an input csv file.

0 commit comments

Comments
 (0)