From 1ba6cd427037599f3f26fdcf00eda77ac3801d02 Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Mon, 7 Oct 2013 15:06:22 -0600 Subject: [PATCH] Started basic documentation --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d7735e..07e9cfe 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ jquery.parse ============ -Robust, efficient CSV parsing (with any delimiting character) +Robust, efficient CSV parsing (with nearly any delimiting character) + + +Basic usage +----------- + +```javascript +results = $.parse(csvString, { + delimiter: "\t", + header: true +}); +``` + +The default delimiter is `,` but can be set to anything anything except `"` or `\n`. + +By default, a header row is expected. The output and error handling depends on whether you include a header row with your data. \ No newline at end of file