improve doc

example/src/main/java/example/ExampleCsvReaderWithClasspathInput.java

@@ -0,0 +1,33 @@
+package example;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.nio.charset.StandardCharsets;
+
+import de.siegmar.fastcsv.reader.CsvReader;
+import de.siegmar.fastcsv.reader.CsvRecord;
+
+/**
+ * Example for reading CSV data from a file in the classpath.
+ */
+public class ExampleCsvReaderWithClasspathInput {
+
+    public static void main(final String[] args) throws IOException {
+        try (CsvReader<CsvRecord> csv = CsvReader.builder().build(getReader("/example.csv"))) {
+            for (final CsvRecord csvRecord : csv) {
+                System.out.println(csvRecord.getFields());
+            }
+        }
+    }
+
+    private static Reader getReader(final String name) {
+        final InputStream in = ExampleCsvReaderWithClasspathInput.class.getResourceAsStream(name);
+        if (in == null) {
+            throw new IllegalStateException("Resource not found: " + name);
+        }
+        return new InputStreamReader(in, StandardCharsets.UTF_8);
+    }
+
+}

lib/src/main/java/de/siegmar/fastcsv/reader/CsvReader.java

@@ -317,7 +317,16 @@ public void close() throws IOException {
 
     /**
      * This builder is used to create configured instances of {@link CsvReader}. The default
-     * configuration of this class complies with RFC 4180.
+     * configuration of this class complies with RFC 4180:
+     * <ul>
+     *     <li>Field separator: {@code ,} (comma)</li>
+     *     <li>Quote character: {@code "} (double quotes)</li>
+     *     <li>Comment strategy: {@link CommentStrategy#NONE} (as RFC doesn't handle comments)</li>
+     *     <li>Comment character: {@code #} (hash) (in case comment strategy is enabled)</li>
+     *     <li>Skip empty lines: {@code true}</li>
+     *     <li>Ignore different field count: {@code true}</li>
+     *     <li>Detect BOM header: {@code false}</li>
+     * </ul>
      * <p>
      * The line delimiter (line-feed, carriage-return or the combination of both) is detected
      * automatically and thus not configurable.

lib/src/main/java/de/siegmar/fastcsv/writer/CsvWriter.java

@@ -297,6 +297,14 @@ public String toString() {
     /**
      * This builder is used to create configured instances of {@link CsvWriter}. The default
      * configuration of this class complies with RFC 4180.
+     * <ul>
+     *     <li>field separator: {@code ,} (comma)</li>
+     *     <li>quote character: {@code "} (double quote)</li>
+     *     <li>comment character: {@code #} (hash/number)</li>
+     *     <li>quote strategy: {@code null} (only required quoting)</li>
+     *     <li>line delimiter: {@link LineDelimiter#CRLF}</li>
+     *     <li>buffer size: 8,192 bytes</li>
+     * </ul>
      */
     @SuppressWarnings({"checkstyle:HiddenField", "PMD.AvoidFieldNameMatchingMethodName"})
     public static final class CsvWriterBuilder {