Skip to content

Commit

Permalink
Add badges
Browse files Browse the repository at this point in the history
  • Loading branch information
camsaul committed Aug 23, 2022
1 parent ea9ca4d commit 71a312f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 6 deletions.
1 change: 0 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ on:
push:
branches:
- master
workflow_dispatch:

jobs:
deploy:
Expand Down
30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,43 @@
<!-- [![cljdoc badge](https://cljdoc.org/badge/com.camsaul/toucan2)](https://cljdoc.org/d/com.camsaul/toucan2/CURRENT) -->
<!-- [![Downloads](https://versions.deps.co/camsaul/toucan2/downloads.svg)](https://versions.deps.co/camsaul/toucan2) -->
<!-- [![Dependencies Status](https://versions.deps.co/camsaul/toucan2/status.svg)](https://versions.deps.co/camsaul/toucan2) -->
<!-- [![Clojars Project](https://clojars.org/com.camsaul/toucan2/latest-version.svg)](https://clojars.org/com.camsaul/toucan2) -->

[![Clojars Project](https://clojars.org/io.github.camsaul/toucan2/latest-version.svg)](https://clojars.org/io.github.camsaul/toucan2)

# Toucan 2

![Toucan 2](https://github.com/camsaul/toucan2/blob/master/assets/toucan2.png)

Toucan 2 is a successor library to [Toucan](https://github.com/metabase/toucan) with a modern and more-extensible API,
more consistent behavior (less gotchas), support for different backends including non-JDBC databases and non-HoneySQL queries, and more useful utilities.
more consistent behavior (less gotchas), support for different backends including non-JDBC databases and non-HoneySQL
queries, and more useful utilities.

Toucan 2 uses [Honey SQL 2](https://github.com/seancorfield/honeysql), [`next.jdbc`](https://github.com/seancorfield/next-jdbc) (a bit), and [Methodical](https://github.com/camsaul/methodical) under the hood. Everything is super efficient and reducible under the hood (even inserts, updates, and deletes!) and magical (in a good way).
Toucan 2 uses [Honey SQL 2](https://github.com/seancorfield/honeysql),
[`next.jdbc`](https://github.com/seancorfield/next-jdbc) (a bit), and
[Methodical](https://github.com/camsaul/methodical) under the hood. Everything is super efficient and reducible under
the hood (even inserts, updates, and deletes!) and magical (in a good way).

After working on this off and on for several years I decided that the library was overly complicated (at nearly 8000
lines of code) and decided to start over and re-implement things in a ~simpler fashion~ (EDIT: back up to 7000 LoC, but it's easier to use this time). The library is mostly usable now but I have a big pile of things to do before the official announcement -- [take a look at the Trello board](https://trello.com/b/DFx8rVa8/toucan-2-todo) -- when things get a little further along I'll move things over to GitHub issues. I will update this README when I publish the
first alpha release.
lines of code) and decided to start over and re-implement things in a ~simpler fashion~ (EDIT: back up to 7000 LoC,
but it's easier to use this time). The library is mostly usable now but I have a big pile of things to do before the
official announcement -- [take a look at the Trello board](https://trello.com/b/DFx8rVa8/toucan-2-todo) -- when things
get a little further along I'll move things over to GitHub issues. I will update this README when I publish the first
alpha release.

In the mean time, browse the [Documentation](docs/), which are a work in progress.

# `toucan2-toucan1`

[![Clojars Project](https://clojars.org/io.github.camsaul/toucan2-toucan1/latest-version.svg)](https://clojars.org/io.github.camsaul/toucan2-toucan1)

Compatibility layer for projects using [Toucan 1](https://github.com/metabase/toucan) to ease transition to Toucan 2.
Implements the same namespaces as Toucan 1, but they are implemented on top of Toucan 2. Projects using Toucan 1 can
remove their dependency on `toucan`, and include a dependency on `io.github.camsaul/toucan2-toucan1` in its place;
with a few changes your project should work without having to switch everything to Toucan 2 all at once. More details
on this coming soon.

See [`toucan2-toucan1` docs](toucan1/README.md) for more information.

## License

Code, documentation, and artwork copyright © 2017-2022 [Cam Saul](https://camsaul.com).
Expand Down
2 changes: 2 additions & 0 deletions toucan1/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Toucan 1 Compatibility

[![Clojars Project](https://clojars.org/io.github.camsaul/toucan2-toucan1/latest-version.svg)](https://clojars.org/io.github.camsaul/toucan2-toucan1)

Toucan 1 reimplemented in terms of Toucan 2. Compatibility layer for existing projects using Toucan 1.

See [Differences from Toucan 1](../docs/differences.md) for the differences between Toucan 2 and Toucan 1.

0 comments on commit 71a312f

Please sign in to comment.