Merge pull request #24 from alan-turing-institute/dev

Update readme

Author: ablaom

README.md

@@ -1,10 +1,24 @@
 # NearestNeighborModels
 
-Repository implementing MLJ interface and weighting kernels for 
-[NearestNeighbors](https://github.com/KristofferC/NearestNeighbors.jl) models.
+Package providing K-nearest neighbor regressors and classifiers, for use with the [MLJ](https://alan-turing-institute.github.io/MLJ.jl/dev/) machine learning framework.
+
+Builds on Kristoffer Carlsson's [NearestNeighbors](https://github.com/KristofferC/NearestNeighbors.jl) package, for performing efficient nearest neighbor searches.
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://vollmersj.github.io/NearestNeighborModels.jl/stable)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://vollmersj.github.io/NearestNeighborModels.jl/dev)
 [![Build Status](https://github.com/alan-turing-institute/NearestNeighborModels.jl/workflows/CI/badge.svg)](https://github.com/alan-turing-institute/NearestNeighborModels.jl/actions)
 [![Coverage](https://codecov.io/gh/alan-turing-institute/NearestNeighborModels.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/vollmersj/NearestNeighborModels.jl)
 
+
+Provides the following models: `KNNRegressor`, `KNNClassifier`,
+`MultitargetKNNRegressor` and `MultitargetClassifier`.
+
+Provides a library of kernels for weighting nearest neighbors, including
+all kernels surveyed in the paper [Geler et.al (2016):
+Comparison of different weighting schemes for the kNN classifier on
+time-series
+data](https://perun.pmf.uns.ac.rs/radovanovic/publications/2016-kais-knn-weighting.pdf)
+
+Do `list_kernels()` for a complete list. 
+
+For instructions on defining a custom kernel, do `?UserDefinedKernel`.