From 65e547131c90e7a734cf223c6d25154b06421f79 Mon Sep 17 00:00:00 2001
From: zymon <s@zymon.org>
Date: Wed, 27 Apr 2022 09:43:47 +0200
Subject: [PATCH] README.md added

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7215aa1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# STFT.jl
+
+
+[![](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 routines.
+It provides signal analysis (time-domain signal to STFT-domain signal; stft)
+and signal synthesis (STFT-domain siganl to time-domain signal; istft).
+
+
+# Examples
+
+```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 = 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
+```