@dynamicstruct and bump version

nsiccha · Dec 19, 2024 · 5f11058 · 5f11058 · nsiccha · Dec 19, 2024
1 parent 7e6f695
commit 5f11058
Show file tree

Hide file tree

Showing 14 changed files with 125 additions and 2,304 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DynamicObjects"
 uuid = "23d02862-63fe-4c6e-8fdb-1d52cbbd39d5"
 authors = ["Nikolas Siccha <nikolassiccha@gmail.com> and contributors"]
-version = "0.1.7"
+version = "0.2.0"
 
 [deps]
 Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"

diff --git a/README.md b/README.md
@@ -1,26 +1,4 @@
 # DynamicObjects.jl
 
-Implements a dynamic object type which can be redefined with convenient/confusing `.`-syntax and caching.
-
-See [https://nsiccha.github.io/examples/DynamicObjects.jl/](https://nsiccha.github.io/examples/DynamicObjects.jl/) for examples.
-
-```julia
-using DynamicObjects
-
-"""
-A fancy rectangle.
-"""
-@dynamic_object Rectangle height width  
-area(what::Rectangle) = what.height * what.width
-
-rect = Rectangle(10, 20)
-println("A $(rect) has an area of $(rect.area).")
-```
-
-```
-A Rectangle(height = 10, width = 20) has an area of 200.
-```
-
-## To add/fix:
-
-* Defining a single argument type without a type on that argument (e.g. `@dynamic_object Circle radius`)
+Provides an `@dynamicstruct` macro, allowing quickly defining structs with cached properties. 
+See [https://nsiccha.github.io/DynamicObjects.jl](https://nsiccha.github.io/DynamicObjects.jl) for a non-minimal example.
diff --git a/examples/README.md b/examples/README.md
diff --git a/examples/_freeze/index/execute-results/html.json b/examples/_freeze/index/execute-results/html.json
diff --git a/examples/_freeze/site_libs/clipboard/clipboard.min.js b/examples/_freeze/site_libs/clipboard/clipboard.min.js
diff --git a/examples/_quarto.yml b/examples/_quarto.yml
diff --git a/examples/cache/area_DynamicShape{:Circle}_13130034305001195947 b/examples/cache/area_DynamicShape{:Circle}_13130034305001195947
diff --git a/examples/cache/description_DynamicShape{:Circle}_552480376105565664 b/examples/cache/description_DynamicShape{:Circle}_552480376105565664
diff --git a/examples/index.qmd b/examples/index.qmd