Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
missn0body committed May 29, 2024
1 parent 8fafd13 commit 92e65c9
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# rle

Under construction!
A simple run-length encoder/decoder
Created in 2024 by anson.

This program uses a lossless [run-length encoding algorithm](https://en.wikipedia.org/wiki/Run-length_encoding)
to compress ASCII files. There hasn't been any
extensive testing with binary or other data files.
For best results, use ASCII files with long runs of
characters, but `rle` will not inflate any file to more
than its original size.

Usage and options can be read by invoking `rle --help` at the
command line. This project is licensed under the MIT License, See
Expand All @@ -9,4 +17,5 @@ discussed at my E-Mail, <[email protected]>

### v.1.0.0

(??? 2024)
(May 2024)
A simple run-length encoder/decoder

0 comments on commit 92e65c9

Please sign in to comment.