Skip to content

Commit 48b7263

Browse files
jonasferozplatypii
andauthored
Update README to template (#5)
* Update README to template * Don't delete my beautiful banner image. Also you broke the table. --------- Co-authored-by: Kenny Daniel <[email protected]>
1 parent e082b1f commit 48b7263

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,28 @@
1313
| License | Apache 2 |
1414
| Input/Output | Output |
1515

16-
# Description
16+
## Description
17+
18+
### Intended Use
1719

1820
A CSV validator for [Guardrails AI](https://www.guardrailsai.com/).
1921

2022
This validator checks for various CSV issues such as mismatched column lengths, or mismatched quote delimiters.
2123

22-
## Requirements
24+
### Requirements
2325

2426
* Dependencies:
2527
- guardrails-ai>=0.4.0
2628

27-
# Installation
29+
## Installation
2830

2931
```bash
3032
$ guardrails hub install hub://hyparam/csv_validator
3133
```
3234

33-
# Usage Examples
35+
## Usage Examples
3436

35-
## Validating string output via Python
37+
### Validating string output via Python
3638

3739
In this example, we apply the validator to a string output generated by an LLM.
3840

@@ -50,7 +52,7 @@ guard.validate("name,email\njohn,[email protected]\njane,[email protected]") # Va
5052
guard.validate("name,email\njohn\njane,[email protected]") # Validator fails
5153
```
5254

53-
## Validating JSON output via Python
55+
### Validating JSON output via Python
5456

5557
In this example, we apply the validator to a string field of a JSON output generated by an LLM.
5658

0 commit comments

Comments
 (0)