Skip to content

Commit a8c4f00

Browse files
committed
Update to README.md installation instructions
- Divided install steps into a project-specific and global section - Moved the current cloverage version flair into the top level of the README fixes cloverage#283
1 parent 8091f1c commit a8c4f00

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,27 @@ Travis: [![Build Status](https://travis-ci.org/cloverage/cloverage.svg?branch=ma
77

88
CircleCI: [![CircleCI](https://circleci.com/gh/cloverage/cloverage.svg?style=shield)](https://circleci.com/gh/cloverage/cloverage)
99

10+
[![Clojars Project](http://clojars.org/lein-cloverage/latest-version.svg)](http://clojars.org/lein-cloverage)
11+
1012
## Installation
1113

12-
Add [![Clojars Project](http://clojars.org/lein-cloverage/latest-version.svg)](http://clojars.org/lein-cloverage) to :plugins in your .lein/profiles.clj
14+
Cloverage can be included into specific projects as a plugin and also be installed user-wide in your `~/.lein/profiles.clj` file. A user-wide installation will make it available to any projects being managed by Leiningen.
15+
16+
### Install Cloverage into a specific project
17+
18+
Add the following to your `project.clj` metadata:
19+
20+
``` clojure
21+
:plugins [[lein-cloverage "1.1.2"]]
22+
```
23+
24+
### Install Cloverage to all Leiningen managed projects
25+
26+
Add the following to your user-wide Leiningen profiles file `~/.lein/profiles.clj`:
27+
28+
``` clojure
29+
{:user {:plugins [[lein-cloverage "1.1.2"]]}}
30+
```
1331

1432
## Testing frameworks support
1533

0 commit comments

Comments
 (0)