Skip to content

Commit 6c49152

Browse files
committed
Update docs on recent release-related changes
1 parent c97193d commit 6c49152

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@ PostgreSQL extensions for the widely used [honeysql](https://github.com/jkk/hone
44

55
This library aims to extend the features of honeysql to support postgres specific SQL clauses and some basic SQL DDL in addition to the ones supported by the parent library. This keeps honeysql clean and single-purpose, any vendor-specific additions can simply be separate libraries that work on top.
66

7-
## Breaking Change
8-
Implementation of `over` has been changed (from 0.2.2) to accept alias as an option and define the aggregator-function within the over clause and not in the select clause, this allows the inclusion of multiple window-function which was not possible in the previous implementation.
7+
## Release
98

10-
The query creation and usage is exactly the same as honeysql.
9+
### Build
10+
This project follows the version scheme MAJOR.MINOR.COMMITS where MAJOR and MINOR provide some relative indication of the size of the change, but do not follow semantic versioning. In general, all changes endeavor to be non-breaking (by moving to new names rather than by breaking existing names). COMMITS is an ever-increasing counter of commits since the beginning of this repository.
11+
12+
### NPM
13+
From version `0.3.104` and onwards, new releases to `npmjs` will not be pushed. The last release available on npmjs is [0.2.6](https://www.npmjs.com/package/@honeysql/honeysql-postgres).
14+
15+
### Known breaking change
16+
Implementation of `over` has been changed (from `0.2.2`) to accept alias as an option and define the aggregator-function within the over clause and not in the select clause, this allows the inclusion of multiple window-functions which was not possible in the previous implementation.
1117

1218
## Index
1319

0 commit comments

Comments
 (0)