From 86b53f12814fb80f019f0ee93d642464879bf59e Mon Sep 17 00:00:00 2001 From: ayyansea Date: Wed, 4 Dec 2024 22:05:31 +0300 Subject: chore: update README (yay!) --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 87c756f..77188db 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,19 @@ This program takes some text, slices it to a number of tokens and applies filter uptfs will be considered complete as soon as all these statements are true: -* it can read text either from stdin or from a plain text file -* it can output text either to stdout or to a file -* it can be configured either fully with command line options or with a YAML file (or with a mix of both) +* it can read text either from stdin or from a plain text file (DONE) +* it can output text either to stdout or to a file (DONE) +* it can be configured either fully with command line options or with a YAML file (or with a mix of both) (DONE) * it has the following configuration options (both in CLI and file modes): * -c, --config-file - path to the config file (DONE) - * -i, --input-file - path to the input file - * -o, --output-file - path to the output file + * -i, --input-file - path to the input file (DONE) + * -o, --output-file - path to the output file (DONE) * -f, --filter - name of a filter to apply (can be used multiple times) (DONE) * it prioritizes command line options over those in the config file (DONE) * it contains at least 7 different predefined filters (DONE) * it has 'normal' and 'verbose' modes, the latter meaning presence of debug logs while the program is running (DONE) Doing more doesn't really make sense since this is a learning project. + +Today, on 12/4/2024, this project reached it's final form. It might look like a hot +mess and need a lot of refactoring and/or optimization, but it's done and I'm glad. -- cgit v1.2.3