Skip to content

Commit

Permalink
Added more information to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
gobbledygook88 committed Jun 2, 2018
1 parent 8b971b7 commit 57a5d99
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 @@ -6,4 +6,38 @@ Let's just leave [this here](https://www.youtube.com/watch?v=iUrzicaiRLU)

## Credits

There's a few - TBD
* Geoff Marshall's [videos](https://www.youtube.com/watch?v=qJc9IDT-kqQ) for [inspiration](https://www.youtube.com/watch?v=sGuetKsW5Ek)
* [TFL tube map](https://tfl.gov.uk/maps/track/tube)
* Web font: [Hammersmith One](https://fonts.google.com/specimen/Hammersmith+One)
* SVG library: [svg-pan-zoom](https://github.com/ariutta/svg-pan-zoom)

## Development

First iteration was written in vanilla Javascript as a proof of concept.
It was then refactored to use [React](https://reactjs.org/) (because I wanted
to learn it and play around) with [`create-react-app`](https://github.com/facebook/create-react-app).

Local development is straightforward:

```
git clone https://github.com/gobbledygook88/knowing-lu.git
cd knowing-lu
npm install
npm start
```

The online version is hosted on Github Pages and deployed with [`gh-pages`](https://github.com/tschaub/gh-pages).

### Testing

Testing is currently in its infancy; they will be written soon.

## Roadmap

Here are a list of features which are nice to have:

* Current progress for each line and zone
* Acheivement badges, e.g. one for each line and zone
* Panning to last correct station (this is in the works, but not yet working correctly)
* Storage of state to some cloud service for cross-device use
* Statistics - local and global

0 comments on commit 57a5d99

Please sign in to comment.