Move docs to readme (#8)

beacon-biosignals · Apr 11, 2024 · 4695e66 · 4695e66 · haberdashPI · Apr 11, 2024
1 parent 41e82c5
commit 4695e66
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 141 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -76,11 +76,12 @@ jobs:
         with:
           version: ${{ steps.version_resolver.outputs.version }}
           arch: ${{ matrix.arch }}
-      - uses: julia-actions/cache@v1
-      - uses: julia-actions/add-julia-registry@v1
+      - uses: actions/cache@v2
         with:
-          key: ${{ secrets.BEACONBUDDY_SSH_KEY }}
-          registry: beacon-biosignals/BeaconRegistry
+            path: ~/.julia/artifacts
+            key: ${{ runner.os }}-test-artifacts-${{ hashFiles('**/Project.toml') }}
+            restore-keys: ${{ runner.os }}-test-artifacts
+      - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
         with:
           annotate: true
@@ -92,10 +93,3 @@ jobs:
           files: lcov.info
           flags: WeakKeyIdDicts
           token: ${{ secrets.CODECOV_TOKEN }}
-      # - name: Percy Upload
-      #   if: ${{ matrix.version == '1' }}
-      #   uses: percy/[email protected]
-      #   with:
-      #     custom-command: "npx @percy/cli upload ./WeakKeyIdDicts.jl/test/test_images"
-      #   env:
-      #     PERCY_TOKEN: ${{ secrets.PERCY_TOKEN_WEAKKEYIDDICTS }}
diff --git a/.github/workflows/Documenter.yml b/.github/workflows/Documenter.yml
diff --git a/README.md b/README.md
@@ -1,9 +1,23 @@
 # WeakKeyIdDicts
 
-[![docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://beacon-biosignals.github.io/WeakKeyIdDicts.jl/dev)
-[![docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://beacon-biosignals.github.io/WeakKeyIdDicts.jl/stable)
 [![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)
 
 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.
+
+It defines one type, `WeakKeyIdDict`, that follows the same API as `Dict`.
+
+```julia
+_tmp_key = [1]
+wkd = WeakKeyIdDict(_tmp_key => 1)
+let tmp = [42]
+    wkd[tmp] = 2
+    @show length(wkd) # 2
+end
+# at this point there is no strong reference left to the vector [42]
+# previously reachable via tmp
+GC.gc(true)
+
+@show length(wkd) # 1
+```
diff --git a/codecov.yml b/codecov.yml
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/Project.toml b/docs/Project.toml
diff --git a/docs/fix_doctests.jl b/docs/fix_doctests.jl
diff --git a/docs/make.jl b/docs/make.jl
diff --git a/docs/src/index.md b/docs/src/index.md