Commit adf05d05 authored by Lena Heizmann's avatar Lena Heizmann

Update readme

parent 061ec386
# CSV-readable
This library exports an abstract class to simplify the import of data into the geolinker form a csv source. It's very specific for te geolinker project.
This library exports an abstract class to simplify the import of data into the geolinker form a csv source. It's very specific for te `geolinker` project.
## Usage
You need to implement three methods of the abstract class. The class helps you to get the data from a csv and abstract the publishing to kafka. You just need to implement a mapping of the csv-schema to the `geolinker` and `linker` kafka topic
You need to implement three methods of the abstract class. The class helps you to get the data from a csv and abstract the publishing to kafka. You just need to implement a mapping of the csv-schema to the `geolinker` and `linker` kafka topic.
```typescript
// you get a array of records from the csv and have to return a concordance
public abstract transformLinks(records): InterfaceConcordance | null;
......@@ -48,4 +48,4 @@ class Test extends CsvReadable {
new Test();
```
We use the class in the [fundmuenzen](https://source.dodis.ch/histhub/fundmuenzen) project
We use the class in the [fundmuenzen](https://source.dodis.ch/histhub/fundmuenzen) project.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment