Skip to content

Commit bcde6ce

Browse files
committed
docs: what is this?
Signed-off-by: Lexus Drumgold <[email protected]>
1 parent 7a2bab8 commit bcde6ce

File tree

3 files changed

+35
-3
lines changed

3 files changed

+35
-3
lines changed

.github/infrastructure.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,10 @@ repository:
180180
squash_merge_commit_title: PR_TITLE
181181
topics:
182182
- ansi
183+
- cli
184+
- logging
183185
- string
186+
- wordwrap
184187
- wrap
185188
visibility: public
186189
vulnerability_alerts: true

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Wrap a string
1818
## Contents
1919

2020
- [What is this?](#what-is-this)
21+
- [Features](#features)
2122
- [Install](#install)
2223
- [Use](#use)
2324
- [API](#api)
@@ -34,7 +35,13 @@ Wrap a string
3435

3536
## What is this?
3637

37-
**TODO**: what is this?
38+
This is a small, but useful package for word-wrapping a string to a specified column width.
39+
40+
### Features
41+
42+
\:rainbow: [ansi][] support\
43+
\:unicorn: emoji and fullwidth character support\
44+
\:arrow\_right: indent and pad lines
3845

3946
## Install
4047

@@ -286,7 +293,7 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md).
286293
This project has a [code of conduct](./CODE_OF_CONDUCT.md). By interacting with this repository, organization, or
287294
community you agree to abide by its terms.
288295
289-
<!-- [aec]: https://en.wikipedia.org/wiki/ANSI_escape_code -->
296+
[ansi]: https://en.wikipedia.org/wiki/ANSI_escape_code
290297
291298
[bun]: https://bun.sh
292299

package.json

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,31 @@
33
"description": "Wrap a string to a specified column width",
44
"version": "0.0.0",
55
"keywords": [
6+
"256",
67
"ansi",
8+
"break",
9+
"cli",
10+
"color",
11+
"colors",
12+
"command-line",
13+
"console",
14+
"escape",
15+
"formatting",
16+
"linewrap",
17+
"log",
18+
"logging",
19+
"rgb",
20+
"shell",
721
"string",
8-
"wrap"
22+
"string",
23+
"styles",
24+
"terminal",
25+
"text",
26+
"tty",
27+
"wordbreak",
28+
"wordwrap",
29+
"wrap",
30+
"xterm"
931
],
1032
"license": "BSD-3-Clause",
1133
"homepage": "https://github.com/flex-development/string-wrap",

0 commit comments

Comments
 (0)