doc update

.travis.yml

@@ -35,16 +35,4 @@ before_script: # homebrew for mac
 after_success:
   # push coverage results to Coveralls
   - julia -e 'VERSION >= v"0.7.0-DEV.5183" && using Pkg; cd(Pkg.dir("FINUFFT")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
-
-# jobs:
-#   include:
-#     - stage: "Documentation"
-#       julia: 1.0
-#       os: linux
-#       script:
-#         - julia --project=docs/ -e 'using Pkg; Pkg.instantiate();
-#                                     Pkg.develop(PackageSpec(path=pwd()));
-#                                     Pkg.build("FINUFFT")'
-#         - julia --project=docs/ docs/make.jl
-#       after_success: skip
 

README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/ludvigak/FINUFFT.jl.svg?branch=master)](https://travis-ci.org/ludvigak/FINUFFT.jl)
 [![Coverage Status](https://coveralls.io/repos/github/ludvigak/FINUFFT.jl/badge.svg?branch=master)](https://coveralls.io/github/ludvigak/FINUFFT.jl?branch=master)
+[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://ludvigak.github.io/FINUFFT.jl/latest/)
 
 This is a Julia interface to [FINUFFT](https://github.com/flatironinstitute/finufft), a lightweight and fast nonuniform FFT (nufft) library released by the Flatiron Institute.
 
@@ -27,13 +28,16 @@ Developed and tested on Linux. Also works on Max OS X, but build script is hardw
 
 This module provides functions `nufft1d1`, `nufft1d2`, ..., `nufft3d3`, `nufft1d1!`, `nufft1d2!`, ..., `nufft3d3!`, and `finufft_default_opts` that call the interface defined in <https://finufft.readthedocs.io/en/latest/usage.html>
 
+A reference of the provided functions is available at <https://ludvigak.github.io/FINUFFT.jl/latest/>
+
 * Function calls mimic the C/C++ interface, with the exception that you don't need to pass the dimensions of any arrays in the argument (they are inferred using `size()`).
 * The functions named `nufftDdN` return the output array.
 * The functions named `nufftDdN!` take the output array as an argument. This needs to be preallocated.
 * The last argument of the nufft routines is the options struct, which is optional. Default values are used if it is omitted.
 * `finufft_default_opts()` returns an options struct with default values.
+* The advanced interfaces `finufft2d1many` and `finufft2d2many` have not been implemented yet.
 
-Example:
+### Example
 ```julia
 using FINUFFT
 
@@ -59,8 +63,6 @@ opts.debug = 1
 fk2 = nufft1d1(x, c, 1, tol, ms, opts)
 ```
 
-The advanced interfaces `finufft2d1many` and `finufft2d2many` have not been implemented yet.
-
 ### More examples
 See [test/runtests.jl](test/runtests.jl)