Skip to content

Commit 18da019

Browse files
authored
feat: add Getting started section to README (#8)
1 parent ba91d63 commit 18da019

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,40 @@
11
# AEMO.MDFF
22

33
[![Build](https://github.com/ahanoff/aemo-mdff-net/actions/workflows/build.yaml/badge.svg)](https://github.com/ahanoff/aemo-mdff-net/actions/workflows/build.yaml)
4+
![NuGet Version](https://img.shields.io/nuget/vpre/AEMO.MDFF)
5+
![NuGet Downloads](https://img.shields.io/nuget/dt/AEMO.MDFF)
6+
![GitHub License](https://img.shields.io/github/license/ahanoff/aemo-mdff-net)
47

58
Parser for Australian Energy Market Operator (AEMO) Meter Data File Format (MDFF) specification
69

10+
## Getting started
11+
12+
Install Nuget package
13+
14+
```shell
15+
dotnet add package AEMO.MDFF
16+
```
17+
18+
Use Nem12Reader to parse csv file
19+
20+
```csharp
21+
using AEMO.MDFF.NEM12;
22+
23+
var nem12Reader = new Nem12Reader();
24+
await using var fs = new FileStream("nem12.csv", FileMode.Open, FileAccess.Read);
25+
await foreach (var r in nem12Reader.ReadAsync(fs, CancellationToken.None))
26+
{
27+
switch (r)
28+
{
29+
case HeaderRecord { VersionHeader: var vh }:
30+
Console.WriteLine(vh);
31+
break;
32+
case NMIDataDetailsRecord { NextScheduledReadDate: var nsrd }:
33+
Console.WriteLine(nsrd.ToLongDateString());
34+
break;
35+
}
36+
}
37+
```
738

839
## References
940

0 commit comments

Comments
 (0)