diff --git a/README.md b/README.md new file mode 100644 index 0000000..4660adc --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# lwrap + +Small utility for wrapping text lines to a certain length. + +## Usage + +Input is provided through stdin, output is written to stdout. + +```sh +$ cat /proc/version +# Linux version 6.15.3-zen1-1-zen (linux-zen@archlinux) (gcc (GCC) 15.1.1 20250425, GNU ld (GNU Binutils) 2.44.0) #1 ZEN SMP PREEMPT_DYNAMIC Thu, 19 Jun 2025 14:41:01 +0000 + +$ cat /proc/version | lwrap +# Linux version 6.15.3-zen1-1-zen (linux-zen@archlinux) (gcc (GCC) 15.1.1 +# 20250425, GNU ld (GNU Binutils) 2.44.0) #1 ZEN SMP PREEMPT_DYNAMIC Thu, 19 Jun +# 2025 14:41:01 +0000 +``` + +## Build + +This project is available both as a 1-file 0-dependencies deno script, or as a packaged executable. This section +explains how to build the executable. + +### Dependencies + +- `deno` This is a typescript on deno project, you need the deno toolchain. Download it with your package manager or + through the installation script at https://deno.com