📝 README - Add light description of the API

ZeroGachis · Oct 6, 2022 · c9e3ebb · c9e3ebb
1 parent f09eba4
commit c9e3ebb
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,3 +26,34 @@ schema = {
 
 rows, errors= csvmagic.parse(data="...", schema=schema)
 ```
+
+
+## API
+
+### File types
+
+- CSV (with or without header)
+- Columnar
+
+### Fields
+
+#### Types
+
+- str
+- int
+- decimal
+
+#### Pre-processors
+
+- left-pad-zeroes
+- map
+- replace
+- strip-whitespaces
+
+#### Validators
+
+- regex-matches
+
+#### Post-processors
+
+- divide