Render README.md with example, plots, and references

Co-authored-by: osorensen <21175639+osorensen@users.noreply.github.com>

Author: Copilot

.gitignore

@@ -4,4 +4,5 @@
 .Ruserdata
 parameter_trace
 *.Rcheck
-*.tar.gz
+*.tar.gz
+README.html

README.md

@@ -9,7 +9,8 @@
 <!-- badges: end -->
 
 BayesMallowsSMC2 provides functions for performing sequential inference
-in the Bayesian Mallows model using the SMC2 algorithm.
+in the Bayesian Mallows model using the SMC2 algorithm (Sørensen et al.
+2025).
 
 ## Installation
 
@@ -21,8 +22,72 @@ You can install the development version of BayesMallowsSMC2 from
 devtools::install_github("osorensen/BayesMallowsSMC2")
 ```
 
-## Usage
+## Example
 
-This package is under development, and is not yet well documented. For
-examples on how to use it, see the code in the OSF repository
-<https://osf.io/pquk4/>.
+Here is a basic example using the included `complete_rankings` dataset:
+
+``` r
+library(BayesMallowsSMC2)
+
+# Fit the model with complete rankings
+set.seed(123)
+mod <- compute_sequentially(
+  complete_rankings,
+  hyperparameters = set_hyperparameters(n_items = 5),
+  smc_options = set_smc_options(n_particles = 100, n_particle_filters = 1)
+)
+
+# Print model summary
+print(mod)
+#> BayesMallowsSMC2 Model
+#> ======================
+#> 
+#> Number of particles:      100
+#> Number of timepoints:     100
+#> Number of items:          5
+#> Number of clusters:       1
+#> 
+#> Log marginal likelihood:  -472.34
+#> Final ESS:                63.55
+#> Resampling events:        5/100
+```
+
+### Posterior Summaries
+
+We can visualize the posterior distributions of the parameters:
+
+``` r
+# Posterior distribution of alpha (dispersion parameter)
+plot(mod, parameter = "alpha")
+```
+
+<img src="man/figures/README-posterior-alpha-1.png" width="100%" />
+
+``` r
+# Posterior distribution of tau (precision parameter)
+plot(mod, parameter = "tau")
+```
+
+<img src="man/figures/README-posterior-tau-1.png" width="100%" />
+
+``` r
+# Posterior distribution of rho (ranking positions)
+plot(mod, parameter = "rho", items = c(1, 2, 3))
+```
+
+<img src="man/figures/README-posterior-rho-1.png" width="100%" />
+
+## References
+
+<div id="refs" class="references csl-bib-body hanging-indent">
+
+<div id="ref-10.1214/25-BA1564" class="csl-entry">
+
+Sørensen, Øystein, Anja Stein, Waldir Leoncio Netto, and David S.
+Leslie. 2025. “<span class="nocase">Sequential Rank and Preference
+Learning with the Bayesian Mallows Model</span>.” *Bayesian Analysis*,
+1–26. <https://doi.org/10.1214/25-BA1564>.
+
+</div>
+
+</div>