Update README.md

README.md

@@ -22,65 +22,66 @@
 
 This package provides a Julia version of MATLAB's `inpaint_nans` function (originally written by John d'Errico, available on the MathWorks [File Exchange website](https://www.mathworks.com/matlabcentral/fileexchange/4551-inpaint_nans) and ported here with his authorization by personal communication).
 
+> [!WARNING]  
+> Out of the methods available in MATLAB's `inpaint_nans`, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) currently only implements MATLAB's method `1`.
+
 Simply put, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) provides a simple `inpaint` function, which takes an array `A` as input and inpaints its `missing` values by solving a simple *n*-dimensional PDE.
 The `inpaint` function can also be used to inpaint `NaN`s or any other values, thanks to the syntax described below and in the [documentation](https://briochemc.github.io/Inpaintings.jl/stable).
 
-## Usage:
+## Usage
 
-Like every Julia package you must first add it via `]add Inpaintings`.
-And every time you want to use [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl), you must start with
-```julia
-julia> using Inpaintings
-```
+> [!TIP]  
+> Like every Julia package you must first add it via `]add Inpaintings`.
+> And every time you want to use [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl), you must start with
+> ```julia
+> julia> using Inpaintings
+> ```
+
+### Inpaint missing values
 
-In order to `inpaint` an array `A`'s `missing` values, simply apply `inpaint` to your array:
 ```julia
 julia> inpaint(A) # will inpaint missing values
 ```
 The array to be inpainted can be a vector, a matrix, or even an *n*-dimensional array.
 
-If your array `A` has some `NaN` values and is filled with floats otherwise, then
+### Inpaint `NaN`s
+
+If your array `A` has no `missing`s, then
 ```julia
 julia> inpaint(A) # will inpaint NaN values
 ```
 
-[Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) provides a syntax to inpaint any specified value via
+### Inpaint specified value
+
+To inpaint any specified value, use
 ```julia
 julia> inpaint(A, -999) # will inpaint -999 values
 ```
-(The value to inpaint can be specified as `NaN` or `missing`, too!)
+> [!TIP]  
+> The value to inpaint can be specified as `NaN` or `missing`, too, if you want to have explicit code.
+
+### Inpaint with a condition function
 
-Alternatively, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) also provides a syntax taking a boolean function `f` as an argument before the array (`f` will be applied to all the elements of the array and must return a boolean).
+Use a function `f` as a first argument (`f` will be applied to all the elements of the array and must return a boolean), to inpaint those values:
 ```julia
 julia> inpaint(f, A)
 ```
 In this case, the values of `A` for which `f` returns `true` will be inpainted.
-(For example, `f` can be, e.g., `ismissing` or `isnan`, but it can also be `x -> x < 0`.)
+> [!TIP]  
+> `f` can be `ismissing` or `isnan`, but it can also be something like `x -> x < 0` for example.
 
-Finally, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) provides a syntax to allow some dimensions to be assumed cyclic:
+### Cyclic dimensions
+
+To allow cyclic dimensions, use
 ```julia
 julia> inpaint(A, cycledims=[1]) # will inpaint A with dimension 1 as cyclic
 ```
 (The cyclic dimensions must be an array of `Int64` that contains the dimension number of cyclic dimensions.)
 
-See the [docs](https://briochemc.github.io/Inpaintings.jl/stable) if you want to see more examples.
-
-## Comparison to MATLAB version
+### Documentation
 
-Out of the methods available in MATLAB's `inpaint_nans`, [Inpaintings.jl](https://github.com/briochemc/Inpaintings.jl) currently only implements the following methods:
-- [ ] method `0`
-- [x] method `1`
-- [ ] method `2`
-- [ ] method `3`
-- [ ] method `4`
-- [ ] method `5`
-
-In the future, it is likely that only `inpaint_nans`'s method `4` (the spring analogy) will be additionally implemented.
-
-## TODOs
+See the [docs](https://briochemc.github.io/Inpaintings.jl/stable) if you want to see more examples.
 
-Suggestions, ideas, issues, and PRs welcome!
+### Contributions
 
-- [ ] improve efficiency
-- [ ] Julian-ify the code
-- [ ] Add notebook exampls via Literate.jl
+Suggestions, ideas, issues, and PRs to improve the code or implement additional methods are welcome!