README

Author: dextorious

README.md

@@ -5,3 +5,31 @@
 [![Coverage Status](https://coveralls.io/repos/deXtoRious/NumericalIntegration.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/deXtoRious/NumericalIntegration.jl?branch=master)
 
 [![codecov.io](http://codecov.io/github/deXtoRious/NumericalIntegration.jl/coverage.svg?branch=master)](http://codecov.io/github/deXtoRious/NumericalIntegration.jl?branch=master)
+
+This is a simple package to provide functionality for numerically integrating presampled data (meaning you can't choose arbitrary nodes). If you have the ability to evaluate your integrand at arbitrary points, please consider using better tools for the job (such as the excellent [FastGaussQuadrature.jl](https://github.com/ajt60gaibb/FastGaussQuadrature.jl)). 
+
+Do note that while the code is trivial, it has not been extensively tested and does not focus on numerical precision. Issues, suggestions and pull requests are welcome.
+
+
+## Example usage
+
+```julia
+# setup some data
+x = collect(-π : π/1000 : π)
+y = sin(x)
+
+# integrate using the default Trapezoidal method
+integrate(x, y)
+
+# integrate using a specific method
+integrate(x, y, SimpsonEven())
+```
+
+The currently available methods are:
+- Trapezoidal
+- TrapezoidalEven
+- TrapezoidalFast
+- TrapezoidalEvenFast
+- SimpsonEven
+
+All methods containing "Even" in the name assume evenly spaced data. All methods containing "Fast" omit basic correctness checks and focus on performance. The fast methods will crash horribly if you supply invalid data.