Update documentation

[lrq3000]

Update the README.md with proper instructions to install the package on Julia > 1.3, and add a few comments to guide the user on how to use the package.

BTW, awesome work on this package! That's currently the only complete SWI software reconstruction package, others (such as swi on MATLAB and Spin-Lite) are now dead links and do not work on nifti but on old defunct image formats. Thanks a lot for making this awesome library under opensource!

[codecov-io]

Codecov Report

Merging #3 into master will decrease coverage by 3.12%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master       #3      +/-   ##
==========================================
- Coverage   61.61%   58.49%   -3.13%     
==========================================
  Files           4        4              
  Lines          99      106       +7     
==========================================
+ Hits           61       62       +1     
- Misses         38       44       +6

Impacted Files	Coverage Δ
src/functions.jl	56.04% <0%> (-3.48%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 845136a...9a9ec5f. Read the comment docs.

[korbinian90]

Thank you a lot for the pull request and your interest in the package!

In the coming weeks I will start with some changes:

• I want to move it to the repository MriResearchTools.jl, which I plan to register in the Julia general register
• The name will change to the acronym CLEAR-SWI, under which it is presented as an abstract at the ISMRM and is currently in the submission process as a full paper. It includes many improvements compared to standard homodyne filtered single-echo SWI. The links for citing it will be added, when published.
• I want to transform the SWI.jl package to a Jupyter notebook showing the usage of CLEAR-SWI from the MriResearchTools.jl package

[lrq3000]

Great to hear the project is alive and kicking! Your plan sounds great!

About transforming SWI.jl into a Jupyter Notebook, I love the idea, but will it still be possible to use it as a package? I think it's very useful to have a standalone package to be able to work it in pipelines.

[korbinian90]

Thanks for the feedback.

All the SWI functionality would be provided from the MriResearchTools package (currently MRI.jl, which is a dependency of SWI.jl at the moment).

Hm, in case a standalone package for SWI makes more sense, I could also keep it like it is now. Then a question is if I register both or only MriResearchTools.