diff --git a/README.md b/README.md index 29bb3d4..c6fcbf9 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ 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 @@ -60,6 +60,17 @@ 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/project/project/target/config-classes/$ecb7fe51448cc98dd236.cache b/project/project/target/config-classes/$675ed81e0b6a7671b546.cache similarity index 100% rename from project/project/target/config-classes/$ecb7fe51448cc98dd236.cache rename to project/project/target/config-classes/$675ed81e0b6a7671b546.cache