= CouchDB client

image:https://github.com/beyonddemise/vertx-couchdb-client/actions/workflows/ci-5.x.yml/badge.svg["Build Status (5.x)",link="https://github.com/beyonddemise/vertx-couchdb-client/actions/workflows/ci-5.x.yml"]

An asynchronous client for interacting whith https://couchdb.apache.org[Apache CouchDB], inspired by https://github.com/apache/couchdb-nano[NodeJS' nano] and https://github.com/vert-x3/vertx-mongo-client[vert.x Mongo client]

Please see the main documentation on the web-site for a full description:

• https://github.com/beyonddemise/vertx-couchdb-client/blob/main/src/main/asciidoc/index.adoc[Java documentation]

Very much work in progress!

== Formating and spotless

We use https://github.com/diffplug/spotless[Spotless] to keep formatting consistent. So you can run:

[source,bash]

mvn spotless:apply

before commiting source code. Or use a https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks[git precommit hook]

[source,bash]

!/bin/bash

Run formatting on pre-commit

files=git status --porcelain | cut -c 4- fulllist='' for f in $files; do fulllist+=(.*)$(basename $f)$'\n' done; list=echo "${fulllist}" | paste -s -d, /dev/stdin echo Working on $list mvn spotless:apply -Dspotless.check.skip=false -DspotlessFiles=$list