readme

joesan · Apr 25, 2019 · 1071a47 · 1071a47
1 parent 7eeb243
commit 1071a47
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -52,14 +52,25 @@ run and click Run
 ### Using the parser
 
 This application is built as a standalone jar and published to the OSS Sonatype repos. To add the parser
-as a dependency to your project:
+as a dependency to your project's build.sbt:
 
 ```
 libraryDependencies += "com.bigelectrons.csvparser" %% "csv-parser" % version
 ```
 
 Latest `version`: [![Latest version](https://index.scala-lang.org/bigelectrons/csv-parser/csv-parser/latest.svg)](https://index.scala-lang.org/bigelectrons/csv-parser/csv-parser)
 
+// TODO: Documentation pending 
+Once added as a dependency, you can use the parser as below:
+
+    case class MeterData(meterId: String, dateTime: DateTime, meterReadings: Seq[Double])
+
+    val canonicalName = Some(classOf[MeterData].getCanonicalName)
+    val meterCsvParserCfg = CSVParserConfig(withHeaders = true, caseClassCanonicalName = canonicalName, splitterFn = Some(meterDataSplitter))
+    val meterCsv = "/Users/joesan/Projects/Private/scala-projects/csv-parser/src/test/resources/meter.csv"
+    val csvParser1 = CsvParser.apply[MeterData]
+    val meterDataSeq: Seq[MeterData] = csvParser1.parse(meterCsv, meterCsvParserCfg)
+
 ## Built With
 
 * [SBT](http://www.scala-sbt.org/) - Scala Build Tool

diff --git a/...onfig-classes/$ecb7fe51448cc98dd236.cache → ...onfig-classes/$675ed81e0b6a7671b546.cache b/...onfig-classes/$ecb7fe51448cc98dd236.cache → ...onfig-classes/$675ed81e0b6a7671b546.cache