update readme

README.md

@@ -5,12 +5,5 @@
 [![CI](https://github.com/beacon-biosignals/WeakKeyIdDicts.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/beacon-biosignals/WeakKeyIdDicts.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![codecov](https://codecov.io/gh/beacon-biosignals/WeakKeyIdDicts.jl/branch/main/graph/badge.svg?token=IeRxFxQwG8&flag=WeakKeyIdDicts)](https://app.codecov.io/gh/beacon-biosignals/WeakKeyIdDicts.jl/tree/main)
 
-TODO: Description of package.
-
-### Delete this section after completing
-- [ ] In this file:
- - [ ] replace the new "TODO" with a short description of this package
- - [ ] replace the `TODO_CODECOVTOKEN` in the above badge with this repo's [codecov token ("Graphing token")](https://app.codecov.io/gh/beacon-biosignals/WeakKeyIdDicts.jl/settings). Note that you may not be able to access this token until your CI has run once and pushed coverage to codecov. Make sure you are signed into codecov!
-- [ ] In [top-level docstring of the package](src/WeakKeyIdDicts.jl), replace the "TODO" with a short description of this package (this will show up as a description in the docs)
-- [ ] Need aws access for ci? In `github/workflows/CI.yml`, uncomment the "uses: aws-actions/configure-aws-credentials@v1" blurb and made sure the `role-to-assume` exists in infra
-- [ ] Need Percy for CI? In `github/workflows/CI.yml`, uncomment the `Percy Upload` section, generate a new token for this package via the Percy UI, and add it to the top level repo as `PERCY_TOKEN_`
+Implements a WeakKeyIdDict which constructs a hash table where the keys are weak
+references to objects that may be garbage collected even when referenced in a hash table.