Skip to content

Commit

Permalink
bump core version and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Yiling-J committed Nov 3, 2024
1 parent c84a81a commit 206efa3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Theine

**IMPORTANT: Theine is currently undergoing a major rewrite and refactor to become a thread-safe, high-performance concurrent cache. V2 will support free-threading in Python and will focus on enhancing multi-threading performance. Some APIs will change in the update.**

High performance in-memory cache inspired by [Caffeine](https://github.com/ben-manes/caffeine).

- High performance [Rust core](https://github.com/Yiling-J/theine-core)
Expand Down Expand Up @@ -63,7 +66,7 @@ Reference:
https://static.usenix.org/event/usenix05/tech/general/full_papers/jiang/jiang_html/html.html


## API
## API (V1)

Key should be a **Hashable** object, and value can be any **Python object**. If key type is not **str/int**, Theine will generate a unique key string automatically, this unique str will use extra space in memory and increase get/set/remove overhead.

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ license = "BSD-3-Clause"
[tool.poetry.dependencies]
python = ">=3.8,<4.0"
typing-extensions = "^4.4.0"
theine-core = "^0.4.3"
theine-core = "^0.4.5"

[tool.poetry.group.dev.dependencies]
pytest = "^7.2.1"
Expand Down

0 comments on commit 206efa3

Please sign in to comment.