Skip to content

Commit

Permalink
Basic readme. Still needs work...
Browse files Browse the repository at this point in the history
  • Loading branch information
Joshua J. A. Harwood committed Mar 12, 2024
1 parent 449f9ae commit 98536e4
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,24 @@ CIFParser is a deserialiser for National Rail ITPS SCHEDULE extracts in the CIF
## Why?

National Rail scheduling data is provided in CIF and JSON format, with CIF format being recommended
for advanced users. This library aims to provide a performant and convenient way to start using this
data.
for advanced users. This library aims to provide a performant and convenient way to use this data.

## Obtaining CIF data

See: https://wiki.openraildata.com/index.php/SCHEDULE

## Requirements

* Java 21

## How to use
### Maven
```xml
<dependency>
TODO: fill me in
</dependency>
```

## Dependencies

idk lol
* `com.pivovarit:parallel-collectors:3.0.0`
* `org.slf4j:slf4j-api:2.0.12`

## Getting started
### Binaries
Binaries are not yet available as this project is in alpha. If you wish to start using this project in its current state, build it and include its JAR in your project.

## Contributing
Any contributions are very welcome.

0 comments on commit 98536e4

Please sign in to comment.