Skip to content

Commit

Permalink
Add more info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
davwheat committed May 15, 2021
1 parent c740656 commit d6e3ffb
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@ This repository contains several files listing all UK railway stations.

Stations listed are only those that can be queried through the National Rail Darwin API.

The dataset was originally from [Trainline EU's repository](https://github.com/trainline-eu/stations).
The dataset was originally from [Trainline EU's repository](https://github.com/trainline-eu/stations). The sources they used at listed on their GitHub repository.

## Contents <!-- omit in toc -->

- [Using the dataset](#using-the-dataset)
- [Git submodules](#git-submodules)
- [NPM](#npm)
- [Attribution](#attribution)
- [Exceptions in data](#exceptions-in-data)
- [Fields](#fields)
- [Data files](#data-files)
Expand All @@ -16,6 +20,36 @@ The dataset was originally from [Trainline EU's repository](https://github.com/t
- [Contributing](#contributing)
- [Licence](#licence)

## Using the dataset

### Git submodules

You can clone this Git repository into your own as a 'submodule'. [Learn more about Git submodules.](https://medium.com/@porteneuve/mastering-git-submodules-34c65e940407)

```properties
git clone https://github.com/davwheat/uk-railway-stations
```

### NPM

You can also pull the dataset from the NPM registry. The default import is the `stations.json` file, but you can also import the `csv` file.

```
npm i uk-railway-stations
yarn add uk-railway stations
```

```js
import StationsListJSON from "uk-railway-stations"
import StationsListCSV from "uk-railway-stations/stations.csv"
```

## Attribution

Attribution must be provided to myself, Trainline EU, and [their sources](https://github.com/trainline-eu/stations#licence) for this dataset.

This is a limitation of the Open Database License (ODbL). For more info, see [LICENSE](LICENSE).

## Exceptions in data

Some notable exceptions exist. These are stations/networks that are **not** included within the data.
Expand Down

0 comments on commit d6e3ffb

Please sign in to comment.