Skip to content

Commit

Permalink
Merge pull request #51 from atc0005/fix-readme-section-header-level-a…
Browse files Browse the repository at this point in the history
…nd-note-input-prompt-scenario

README: adjust section header, note input prompt
  • Loading branch information
atc0005 authored Jun 16, 2023
2 parents 69b0707 + 8d4ed4f commit 6304b04
Showing 1 changed file with 27 additions and 3 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,12 @@ Go-based tooling to manipulate (e.g., normalize/decode) Microsoft Office 365
- [Command-line arguments](#command-line-arguments)
- [`usl`](#usl)
- [Flags](#flags)
- [Positional Argument](#positional-argument)
- [Positional Argument](#positional-argument)
- [Just Hit Enter](#just-hit-enter)
- [Examples](#examples)
- [Using positional argument](#using-positional-argument)
- [Using flag](#using-flag)
- [Using input prompt](#using-input-prompt)
- [Verbose output](#verbose-output)
- [License](#license)
- [References](#references)
Expand Down Expand Up @@ -170,10 +172,18 @@ binaries.
| `v`, `verbose` | No | `false` | No | `v`, `verbose` | Toggles listing of all processes. WARNING: This may produce a LOT of output. Disabled by default. |
| `u`, `url` |

#### Positional Argument
##### Positional Argument

A URL pattern is accepted as a single positional argument in place of the `u`
or `url` flag.
or `url` flag. It is recommended that you quote the URL pattern to help
prevent some of the characters from being interpreted as shell commands (e.g.,
`&` as an attempt to background a command).

##### Just Hit Enter

The `usl` tool can also be called without any flags or positional argument. In
this scenario it will prompt you to insert/paste the URL pattern (quoted or
otherwise).

## Examples

Expand All @@ -200,6 +210,20 @@ Original URL:
https://go.dev/dl/
```

### Using input prompt

In this example we just press enter so that we will be prompted for the input
URL pattern.

```console
$ ./usl
Enter URL: SafeLinksURLHere

Original URL:

https://go.dev/dl/
```

### Verbose output

```console
Expand Down

0 comments on commit 6304b04

Please sign in to comment.