Skip to content

Commit

Permalink
No commit message
Browse files Browse the repository at this point in the history
  • Loading branch information
NikolaRHristov committed Jul 30, 2024
1 parent 06792cf commit dd1c0ba
Showing 1 changed file with 22 additions and 15 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,19 @@ cargo install psummary

The Summary tool can be used with various options:

```sh
Summary [OPTIONS]
```
🗣️ Summary —
Usage: Summary [OPTIONS]
Options:
-P, --Parallel ⏩ Parallel —
-R, --Root <ROOT> 📂 Root — [default: .]
-E, --Exclude <EXCLUDE> 🚫 Exclude — [default: node_modules]
--Pattern <PATTERN> 🔍 Pattern — [default: .git]
-O, --Omit <OMIT> 🚫 Omit — [default: Documentation]
-h, --help Print help
-V, --version Print version
```

This command will generate summaries for all the Git tags inside the specified
Expand All @@ -50,30 +61,26 @@ repository.

The `Summary` tool can be used with various options:

#### --Root or -R:
#### --Exclude or -E:

Set the current working directory to a different folder (default is `.`):
Exclude certain files or directories (defailt is `node_modules`).

#### --Parallel or -P:
#### --Omit or -O:

Run processing in parallel (default is `sequential`):
Specify regex patterns to omit files from processing (default is
"Documentation").

#### --Exclude:
#### --Parallel or -P:

Exclude certain files or directories (defailt is `node_modules`).
Run processing in parallel (default is `sequential`):

#### --Pattern:

Specify a custom pattern for matching (defailt is `.git`).

#### --Separator:

Define a custom separator (default is system path separator).

#### --Omit or -O:
#### --Root or -R:

Specify regex patterns to omit files from processing (default is
"Documentation").
Set the current working directory to a different folder (default is `.`):

For [Pieces OS] integration, refer to the [Pieces OS] documentation for specific
flags and configuration options. [Pieces OS]
Expand Down

0 comments on commit dd1c0ba

Please sign in to comment.