Skip to content

Commit 72b50ab

Browse files
authored
Merge pull request #4 from pomcho555/fix-wrongly-placed-toc
Fix wrongly placed toc
2 parents 91a0662 + 861157b commit 72b50ab

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
1+
# RSP (Raw String Peeler)
2+
3+
A Rust CLI tool that converts escaped strings embedded in YAML ConfigMaps into properly formatted multi-line strings using YAML's pipe (`|`) syntax.
4+
15
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
26
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
37
## Table of Contents
48

5-
- [RSP (Raw String Peeler)](#rsp-raw-string-peeler)
6-
- [Table of Contents](#table-of-contents)
7-
- [Installation](#installation)
8-
- [From Source](#from-source)
9-
- [Prerequisites](#prerequisites)
10-
- [Get Started](#get-started)
11-
- [Basic Usage](#basic-usage)
12-
- [What it does](#what-it-does)
13-
- [Supported file types](#supported-file-types)
14-
- [Testing](#testing)
15-
- [CI/CD](#cicd)
16-
- [License](#license)
17-
- [Contribution](#contribution)
18-
- [Project Structure](#project-structure)
9+
- [Installation](#installation)
10+
- [From Source](#from-source)
11+
- [Prerequisites](#prerequisites)
12+
- [Get Started](#get-started)
13+
- [Basic Usage](#basic-usage)
14+
- [What it does](#what-it-does)
15+
- [Supported file types](#supported-file-types)
16+
- [Testing](#testing)
17+
- [CI/CD](#cicd)
18+
- [License](#license)
19+
- [Contribution](#contribution)
20+
- [Project Structure](#project-structure)
1921

2022
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2123

22-
# RSP (Raw String Peeler)
23-
24-
A Rust CLI tool that converts escaped strings embedded in YAML ConfigMaps into properly formatted multi-line strings using YAML's pipe (`|`) syntax.
25-
26-
## Table of Contents
27-
2824
## Installation
2925

3026
### From Source
@@ -55,12 +51,17 @@ cargo install --path .
5551

5652
Process a YAML ConfigMap file and output to stdout:
5753
```bash
58-
rsp input.yaml
54+
rsp peel input.yaml
5955
```
6056

6157
Process a file and save to output file:
6258
```bash
63-
rsp input.yaml -o output.yaml
59+
rsp peel input.yaml -o output.yaml
60+
```
61+
62+
Process a file from pipe:
63+
```bash
64+
cat input.yaml |rsp peel
6465
```
6566

6667
## What it does

0 commit comments

Comments
 (0)