A Clojure(Script) utility library for all of your brewing needs.
This repository follows the guidelines and standards of the Wall Brew Open Source Policy.
A deployed copy of the most recent version of brewtility can be found on clojars. To use it, add the following as a dependency in your project.clj file:
The next time you build your application, Leiningen or deps.edn should pull it automatically. Alternatively, you may clone or fork the repository to work with it directly.
This library is designed to work in conjunction with the common-beer-format. The functions within the library make one main assumptions based on that fact:
- All measurements are expected to be in the International System of Units, also known as the modern metric system. Since many brewing applications, especially those based in America, operate on Imperial Measurements, conversion utilities have been provided in the
brewtility.unitsnamespace.
Below are examples of provided functionality for each namespace. The library does provide access to other functions, but those primarily exist in support of those outlined here.
Brewtility follows several conventions and design patterns that result in artifacts available to library consumers. These are not strictly required for use; however, they provide additional documentation and ease-of-use to those who adopt them.
doo, a Leiningen plugin used to run ClojureScript tests in many JS environments, is already in project.clj.
Karma is used as the test runner, and is included in package.json.
To install Karma, simply install the Node package:
npm installThen build the application and run the tests:
lein test-buildThe tests will also execute on the JVM, to ensure the library is compatible for apps in both deployment environments.
Copyright © Wall Brew Co
This software is provided for free, public use as outlined in the MIT License