docs/basic_api.md in smarter_csv-1.12.0.pre1 vs docs/basic_api.md in smarter_csv-1.12.0
- old
+ new
@@ -1,8 +1,22 @@
-# SmarterCSV API
+### Contents
+ * [Introduction](./_introduction.md)
+ * [**The Basic API**](./basic_api.md)
+ * [Batch Processing](././batch_processing.md)
+ * [Configuration Options](./options.md)
+ * [Row and Column Separators](./row_col_sep.md)
+ * [Header Transformations](./header_transformations.md)
+ * [Header Validations](./header_validations.md)
+ * [Data Transformations](./data_transformations.md)
+ * [Value Converters](./value_converters.md)
+
+--------------
+
+# SmarterCSV Basic API
+
Let's explore the basic APIs for reading and writing CSV files. There is a simplified API (backwards conpatible with previous SmarterCSV versions) and the full API, which allows you to access the internal state of the reader or writer instance after processing.
## Reading CSV
SmarterCSV has convenient defaults for automatically detecting row and column separators based on the given data. This provides more robust parsing of input files when you have no control over the data, e.g. when users upload CSV files.
@@ -136,5 +150,8 @@
file_location = 'http://your.remote.org/sample.csv'
open(file_location, 'r:utf-8') do |f| # don't forget to specify the UTF-8 encoding!!
data = SmarterCSV.process(f)
end
```
+
+----------------
+PREVIOUS: [Introduction](./_introduction.md) | NEXT: [Batch Processing](./batch_processing.md)