Add README

qexat · Apr 14, 2024 · e14fe14 · e14fe14
1 parent 51ec4f6
commit e14fe14
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# anstrip
+
+anstrip is a minimal library to strip ANSI sequences from strings.
+
+It provides:
+
+- `PATTERN`, the regex pattern used by the functions of anstrip
+- `strip`, a function to remove all the escape sequences from a string
+- `auto_strip`, a function that is similar to `strip`, except that it only removes if the output is a TTY
+- `auto_print`, a function that is `print` but with sequence auto-stripping
+- `printed_length`, a function that returns the length of the string as seen on the screen
diff --git a/src/anstrip/__init__.py b/src/anstrip/__init__.py
@@ -2,9 +2,10 @@
 anstrip is a minimal library to strip ANSI sequences from strings.
 
 It provides:
-- the regex pattern used by the functions of anstrip
+- `PATTERN`, the regex pattern used by the functions of anstrip
 - `strip`, a function to remove all the escape sequences from a string
 - `auto_strip`, a function that is similar to `strip`, except that it only removes if the output is a TTY
+- `auto_print`, a function that is `print` but with sequence auto-stripping
 - `printed_length`, a function that returns the length of the string as seen on the screen
 """