Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
# RSP (Raw String Peeler)

A Rust CLI tool that converts escaped strings embedded in YAML ConfigMaps into properly formatted multi-line strings using YAML's pipe (`|`) syntax.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents

- [RSP (Raw String Peeler)](#rsp-raw-string-peeler)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [From Source](#from-source)
- [Prerequisites](#prerequisites)
- [Get Started](#get-started)
- [Basic Usage](#basic-usage)
- [What it does](#what-it-does)
- [Supported file types](#supported-file-types)
- [Testing](#testing)
- [CI/CD](#cicd)
- [License](#license)
- [Contribution](#contribution)
- [Project Structure](#project-structure)
- [Installation](#installation)
- [From Source](#from-source)
- [Prerequisites](#prerequisites)
- [Get Started](#get-started)
- [Basic Usage](#basic-usage)
- [What it does](#what-it-does)
- [Supported file types](#supported-file-types)
- [Testing](#testing)
- [CI/CD](#cicd)
- [License](#license)
- [Contribution](#contribution)
- [Project Structure](#project-structure)

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

# RSP (Raw String Peeler)

A Rust CLI tool that converts escaped strings embedded in YAML ConfigMaps into properly formatted multi-line strings using YAML's pipe (`|`) syntax.

## Table of Contents

## Installation

### From Source
Expand Down Expand Up @@ -55,12 +51,17 @@ cargo install --path .

Process a YAML ConfigMap file and output to stdout:
```bash
rsp input.yaml
rsp peel input.yaml
```

Process a file and save to output file:
```bash
rsp input.yaml -o output.yaml
rsp peel input.yaml -o output.yaml
```

Process a file from pipe:
```bash
cat input.yaml |rsp peel
```

## What it does
Expand Down
Loading