Skip to content

Commit 58aae58

Browse files
committed
Bump the library version to v0.3.0
Add a changelog of all the changes
1 parent bf98529 commit 58aae58

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

changelog/0.3.0.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
-*- mode: org; comment-column: 0; -*-
2+
3+
* Version
4+
- 0.3.0
5+
- Release Date: <2021-07-25 Sun>
6+
7+
* Changes
8+
- This release contains *significant breaking changes*
9+
- The API now supports Clojure vectors as Tuples and Subspaces (they
10+
are converted internally). This makes the library much more
11+
intuitive to use and my recommendation is to always use Subspaces +
12+
Tuples for keys and where possible use Tuples for values in FDB.
13+
- ~encode~ and ~decode~ functions have been removed from the core API.
14+
When using vectors, they are unnecessary.
15+
- Support for top-level ~keyfn~ and ~valfn~ arguments has been moved
16+
to an ~opts~ map, which will support more options in the future.
17+
- The behavior of ~keyfn~ / ~valfn~ has changed and become more
18+
intuitive. Refer to examples in the README to understand how to use
19+
these functions.
20+
- ~parsefn~ has been renamed to ~valfn~ for consistency
21+
- MutationType and ~mutate~ support is now available and baked into
22+
the core API. (Check out docs for ~fc/mutate!~ and it's usage in
23+
~farstar~)
24+
- The following functionality will be added in upcoming releases:
25+
+ Leveraging the power of Clojure for FDB async operations
26+
+ Full support for FDB watches
27+
+ Support for versionstamps
28+
- This library is still in the 0.x stage. I expect new releases to
29+
have breakage in API until I get to the 1.0.0 release, post which
30+
the API will be permanently supported.
31+
32+
* Commit history
33+
34+
- (#18) MutationType support is now available in the core API as ~fc/mutate!~
35+
- Auto handle vectors, remove encode/decode from core API
36+
- Provide a consistent ~create~ function across Tuple, Subspace, Directory layers

0 commit comments

Comments
 (0)