chore: add CI

.github/workflows/CompatHelper.yml

@@ -0,0 +1,19 @@
+name: CompatHelper
+
+on:
+  schedule:
+    - cron: '00 00 * * *'
+
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: 1.3
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

.github/workflows/TagBot.yml

@@ -0,0 +1,14 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/main.yml

@@ -0,0 +1,15 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: ['1.10', '1']
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/[email protected]
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+      - uses: julia-actions/julia-runtest@v1

README.md

@@ -18,6 +18,29 @@ julia> ] # to enter package mode
 pkg> add AdaptiveEstimators
 ```
 
+## API
+
+Currently, the public API consists of only the following:
+```
+# fit model to data (x, y) using specified algorithm
+fit!(model::SystemModel, alg::Estimator, x, y; saveat, rng)
+fit!(model::SystemModel, alg::Estimator, x, y, nsteps, decision; ...)
+
+# available models
+LinearModel(ptype, n)
+DFE(ffsize, fbsize)
+DFE(T, ffsize, fbsize)
+
+# available estimation algorithms
+LMS(μ=0.01)
+NLMS(μ=0.1)
+RLS(λ=0.99, σ=1.0)
+
+# utilities
+nearest(constellation)
+```
+See docstrings (`help fit!`, etc) for details.
+
 ## Examples
 
 ### Channel estimation
@@ -113,29 +136,6 @@ scatter(r.y[513:end]; markersize=2, legend=false, title="SER=$(round(ser; digits
 
 Perfect equalization!
 
-## API
-
-Currently, the public API consists of only the following:
-```
-# fit model to data (x, y) using specified algorithm
-fit!(model::SystemModel, alg::Estimator, x, y; saveat, rng)
-fit!(model::SystemModel, alg::Estimator, x, y, nsteps, decision; ...)
-
-# available models
-LinearModel(ptype, n)
-DFE(ffsize, fbsize)
-DFE(T, ffsize, fbsize)
-
-# available estimation algorithms
-LMS(μ=0.01)
-NLMS(μ=0.1)
-RLS(λ=0.99, σ=1.0)
-
-# utilities
-nearest(constellation)
-```
-See docstrings (`help fit!`, etc) for details.
-
 ## Contributing
 
 Contributions in the form of bug reports, feature requests, ideas/suggestions, bug fixes, code enhancements, and documentation updates are most welcome. To understand the design of the package, a good starting point is the documentation of the model and estimation algorithm API in [`types.jl`](src/types.jl).