Skip to content

Commit

Permalink
Add a bit more info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
@frankier
frankier committed Nov 29, 2023
1 parent aec58ad commit a9508ad
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,12 @@
[![Build Status](https://github.com/JuliaPsychometricsBazaar/AdaptiveTestPlots.jl/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/JuliaPsychometricsBazaar/AdaptiveTestPlots.jl/actions/workflows/test.yml?query=branch%3Amain)


This is a package for plotting recordings of CATs (Computerised Adaptive Tests).
This is a package for plotting recordings of CATs (Computerised Adaptive
Tests), as well as plots for fitted item banks from
[FittedItemBanks.jl](https://github.com/JuliaPsychometricsBazaar/FittedItemBanks.jl).

Usage examples will soon be provied in the
[`ComputerAdaptiveTesting.jl` examples](https://juliapsychometricsbazaar.github.io/ComputerAdaptiveTesting.jl/dev/examples/)
and the
[CAT experiments](https://github.com/JuliaPsychometricsBazaar/CATExperiments)
repository.

2 comments on commit a9508ad

@frankier
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/96130

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" a9508ad91dcc84b5dada4d07ae4ed1b842cb074a
git push origin v0.1.0

Please sign in to comment.