From 78c7f82812eacc253dec423b846d08590e9ee347 Mon Sep 17 00:00:00 2001 From: Kris Yotam <75515498+krisyotam@users.noreply.github.com> Date: Thu, 14 May 2026 16:25:19 -0500 Subject: [PATCH] convert README.md to README.txt --- README.md | 47 ---------------------------------------------- README.txt | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 47 deletions(-) delete mode 100644 README.md create mode 100644 README.txt diff --git a/README.md b/README.md deleted file mode 100644 index 5ccc35128e3c9db3a159ac9a01a25d5d0e0923e3..0000000000000000000000000000000000000000 --- a/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# sparser - -Simple URL extractor from text files. Suckless C tool. - -sparser scans files for external URLs and prints them to stdout, one per line. It handles HTML, Markdown, MDX, and plain text. Optionally recurses directories and deduplicates output. - -## Usage - -``` -sparser [-vuR] [path | -] - - -v verbose (print filenames to stderr) - -u deduplicate URLs - -R recursive directory scan - - path file or directory to scan - - read from stdin -``` - -## Examples - -```sh -# Extract URLs from a single file -sparser notes.md - -# Recursively scan a directory, deduplicate -sparser -uR ~/documents/ - -# Pipe from stdin -curl -s https://example.com | sparser - -``` - -## Configuration - -Edit `config.h` to adjust file size limits, max URL length, and line buffer size. - -## Requirements - -A C compiler and POSIX headers. - -## Installation - -Edit `config.mk` to match your local setup, then: - -```sh -make clean install -``` diff --git a/README.txt b/README.txt new file mode 100644 index 0000000000000000000000000000000000000000..e3c3e71095583e2b154eb3bdc32f13c193f9d0d8 --- /dev/null +++ b/README.txt @@ -0,0 +1,55 @@ +sparser + + +Simple URL extractor from text files. Suckless C tool. + +sparser scans files for external URLs and prints them to stdout, one per +line. It handles HTML, Markdown, MDX, and plain text. Optionally recurses +directories and deduplicates output. + + +USAGE + + sparser [-vuR] [path | -] + + -v verbose (print filenames to stderr) + -u deduplicate URLs + -R recursive directory scan + + path file or directory to scan + - read from stdin + + +EXAMPLES + + Extract URLs from a single file: + sparser notes.md + + Recursively scan a directory, deduplicate: + sparser -uR ~/documents/ + + Pipe from stdin: + curl -s https://example.com | sparser - + + +CONFIGURATION + + Edit config.h to adjust file size limits, max URL length, and line + buffer size. + + +REQUIREMENTS + + A C compiler and POSIX headers. + + +INSTALLATION + + Edit config.mk to match your local setup, then: + + make clean install + + +LICENSE + + MIT