From 346c7438b760a5e6795b007551232d8567e8f8b1 Mon Sep 17 00:00:00 2001
From: zymon <s@zymon.org>
Date: Wed, 11 May 2022 14:13:32 +0200
Subject: [PATCH] README.md update

---
 README.md | 79 ++++++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 61 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index e05823c..8050683 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,74 @@
-# STFT.jl
+# `STFT.jl` - Short-Time Fourier Transform
 
 
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.zymon.org/STFT.jl/)
 
-`STFT.jl` is a Julia package implementing Short-Time Fourier Transform (STFT) routines.
-It provides signal analysis (time-domain signal to STFT-domain signal; stft)
-and signal synthesis (STFT-domain siganl to time-domain signal; istft).
+`STFT.jl` is a small Julia package implementing just Short-Time Fourier Transform (STFT) routines.
+It provides the following core functionality:
+- **_signal analysis_**; transform time-domain signal to STFT-domain signal.
+- **_signal synthesis_**; transform STFT-domain signal to time-domain signal.
 
+Check the [documentation](https://docs.zymon.org/STFT.jl/) for more insights.
 
-# Examples
+## Installation
+
+The package is currently not available in [General](https://github.com/JuliaRegistries/General), the default Julia package registry.
+
+To install it, use the following command in Julia package manager:
+```julia
+pkg> add https://github.com/s-zymon/STFT.jl
+```
+
+## Examples
+
+Below you can find a few standalone example with basic usage of the package.
+
+### Show spectrogram
+
+```julia
+using STFT
+using Plots
+
+x = randn(10000)  # Generate mock signal
+W = 64            # Window length
+w = ones(W)       # Rectangular analysis window
+H = 10            # Hop
+L = W - H         # Overlap
+
+X = stft(x, w, L)    # Analysis
+s = abs2.(X)         # Compute spectrogram
+heatmap(10log10.(s)) # Display spectrogram
+```
+
+### Analyse signal, modify, and synthesise
+```julia
+using STFT
+
+x = randn(10000)   # Generate mock signal
+W = 64             # Window length
+w = ones(W)        # Rectangular analysis window
+H = 10             # Hop
+L = W - H          # Overlap
+
+X = stft(x, w, L)  # Analysis
+X = f(X)           # Modify STFT-domain signal
+y = istft(X, w, L) # Synthesis
+```
+
+Alternatively, instead of `using STFT`, you can `import STFT`,
+and use an alternative API, i.e., `analysis` and `synthesis`.
 
 ```julia
 import STFT
 
-x = rand(10000) # Generate mock signal
-W = 64          # Window length
-w = ones(W)     # Rectangular analysis window
-H = 10          # Hop
-L = W - H       # Overlap
+x = randm(10000) # Generate mock signal
+W = 64           # Window length
+w = ones(W)      # Rectangular analysis window
+H = 10           # Hop
+L = W - H        # Overlap
 
 X = STFT.analysis(x, w, L)  # Analysis
-
-# Compute spectogram of the signal
-spectogram = abs2.(X)
-
-# X = f(X) # Modify STFT-domain signal
-
-# Reconsturction
-xr = STFT.synthesis(X, w, L) # Synthesis
+X = f(X)                    # Modify STFT-domain signal
+y = STFT.synthesis(X, w, L) # Synthesis
 ```
+