Add NCO, DDS, and loop filter to feature list

mhostetter · Jul 9, 2023 · 86c1eab · 86c1eab
1 parent 22e82c6
commit 86c1eab
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -21,5 +21,12 @@ A Python package for software-defined radio.
 
 ## Features
 
-- Filters: Infinite impulse response filters (`sdr.IIR`)
-- Arbitrary resamplers: Farrow resampler (`sdr.FarrowResampler`)
+- Filters:
+   - Infinite impulse response filter (`sdr.IIR`)
+- Arbitrary resamplers:
+   - Farrow resampler (`sdr.FarrowResampler`)
+- Signal generators:
+   - Numerically-controlled oscillator (`sdr.NCO`)
+   - Direct digital synthesizer (`sdr.DDS`)
+- Phase-locked loops:
+   - Loop filter (`sdr.LoopFilter`)
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,8 +7,15 @@ The :obj:`sdr` library is a Python 3 package for software-defined radio (SDR) ap
 Features
 --------
 
-- Filters: Infinite impulse response filters (:obj:`sdr.IIR`)
-- Arbitrary resamplers: Farrow resampler (:obj:`sdr.FarrowResampler`)
+- Filters:
+   - Infinite impulse response filter (:obj:`sdr.IIR`)
+- Arbitrary resamplers:
+   - Farrow resampler (:obj:`sdr.FarrowResampler`)
+- Signal generators:
+   - Numerically-controlled oscillator (:obj:`sdr.NCO`)
+   - Direct digital synthesizer (:obj:`sdr.DDS`)
+- Phase-locked loops:
+   - Loop filter (:obj:`sdr.LoopFilter`)
 
 .. toctree::
    :caption: Examples