Skip to content

Commit a0ff340

Browse files
committed
Updating README file
1 parent 320ad01 commit a0ff340

1 file changed

Lines changed: 42 additions & 4 deletions

File tree

README.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,45 @@
1-
# ModelBasedCF
1+
# ModelBasedCF.jl
22

3-
[![Build Status](https://travis-ci.org/filipebraida/ModelBasedCF.jl.svg?branch=master)](https://travis-ci.org/filipebraida/ModelBasedCF.jl)
3+
*Model based algorithms for Collaborative Filtering in Julia*
44

5-
[![Coverage Status](https://coveralls.io/repos/filipebraida/ModelBasedCF.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/filipebraida/ModelBasedCF.jl?branch=master)
5+
| **Build Status** |
6+
|:-----------------------------------------------------------------------------------------------:|
7+
| [![][docs-dev-img]][docs-dev-url] | [![][travis-img]][travis-url] [![][coverage-img]][coverage-url] [![][codecov-img]][codecov-url] |
68

7-
[![codecov.io](http://codecov.io/github/filipebraida/ModelBasedCF.jl/coverage.svg?branch=master)](http://codecov.io/github/filipebraida/ModelBasedCF.jl?branch=master)
9+
10+
## Installation
11+
12+
The package can be installed with the Julia package manager.
13+
From the Julia REPL, type `]` to enter the Pkg REPL mode and run:
14+
15+
```
16+
pkg> add ModelBasedCF
17+
```
18+
19+
Or, equivalently, via the `Pkg` API:
20+
21+
```julia
22+
julia> import Pkg; Pkg.add("ModelBasedCF")
23+
```
24+
25+
[contrib-url]: https://juliadocs.github.io/Documenter.jl/latest/man/contributing/
26+
27+
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
28+
[docs-dev-url]: https://juliarecsys.github.io/ModelBasedCF.jl/latest
29+
30+
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
31+
[docs-stable-url]: https://juliarecsys.github.io/ModelBasedCF.jl/stable
32+
33+
[travis-img]: https://travis-ci.org/JuliaRecsys/ModelBasedCF.jl.svg?branch=master
34+
[travis-url]: https://travis-ci.org/JuliaRecsys/ModelBasedCF.jl
35+
36+
[appveyor-img]: https://ci.appveyor.com/api/projects/status/xx7nimfpnl1r4gx0?svg=true
37+
[appveyor-url]: https://ci.appveyor.com/project/JuliaDocs/documenter-jl
38+
39+
[codecov-img]: https://codecov.io/gh/JuliaRecsys/ModelBasedCF.jl/branch/master/graph/badge.svg
40+
[codecov-url]: https://codecov.io/gh/JuliaRecsys/ModelBasedCF.jl
41+
42+
[coverage-img]: https://coveralls.io/repos/JuliaRecsys/ModelBasedCF.jl/badge.svg?branch=master&service=github
43+
[coverage-url]: https://coveralls.io/github/JuliaRecsys/ModelBasedCF.jl?branch=master
44+
45+
[issues-url]: https://github.com/JuliaRecsys/ModelBasedCF.jl/issues

0 commit comments

Comments
 (0)