all: finish the README, prepare for initial release

ID

93b0316

date

2026-11-07 14:48:06+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

1a1ef6a

message

all: finish the README, prepare for initial release

changed files

3 files, 18 additions, 1 deletion

CHANGELOG.md
README.md
src/funkycache/version.py

Changed files

CHANGELOG.md (0 → 54)

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..55c0d38
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## v1.0.0 - 2026-11-07
+
+Initial release.

README.md (1138 → 1288)

diff --git a/README.md b/README.md
index c444604..3fbb8fd 100644
--- a/README.md
+++ b/README.md
@@ -31,3 +31,15 @@ If those dependent values change, the function's cache is invalidated, and the n
 
 **Note:** funkycache does not watch the filesystem.
 It is your responsibility to notify it of changes to dependent files, or they will be noticed when the Python process restarts.
+
+## Installation
+
+Install using pip:
+
+```console
+$ pip install funkycache
+```
+
+## License
+
+This project is shared under the [MIT license](./LICENSE).

src/funkycache/version.py (55 → 55)

diff --git a/src/funkycache/version.py b/src/funkycache/version.py
index ad32e07..bed9a72 100644
--- a/src/funkycache/version.py
+++ b/src/funkycache/version.py
@@ -2,4 +2,4 @@
 The FunkyCache version.
 """
 
-__version__ = "0.0.1"
+__version__ = "1.0.0"