Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add installation instructions for tools.deps. #18

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add installation instructions for tools.deps. #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,16 @@ transmitting Clojure data in a more compact form.

## Installation

Library releases are published on Clojars. To use the latest version with
Leiningen, add the following dependency to your project definition:
Library releases are published on Clojars. To use the latest version,
add the following dependency to your project definition:

[![Clojars Project](http://clojars.org/mvxcvi/clj-cbor/latest-version.svg)](http://clojars.org/mvxcvi/clj-cbor)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like addition of the tools.deps instructions, but I'm loathe to lose the automatic release version from the banner here. Maybe clojars has a tools.deps-style banner we could show too? If not, I'd prefer the tools.deps section to use a "RELEASE" placeholder or instruct the reader to use the version shown here.

### Leiningen

Add `[mvxcvi/clj-cbor "1.1.0"]` to your `project.clj` file.

### tools.deps

Add `mvxcvi/clj-cbor {:mvn/version "1.1.0"}` to your `deps.edn` file.

## Usage

Expand Down