Skip to content

Commit

Permalink
Updating README file
Browse files Browse the repository at this point in the history
  • Loading branch information
filipebraida committed Oct 15, 2019
1 parent 320ad01 commit a0ff340
Showing 1 changed file with 42 additions and 4 deletions.
46 changes: 42 additions & 4 deletions README.md
@@ -1,7 +1,45 @@
# ModelBasedCF
# ModelBasedCF.jl

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

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

[![codecov.io](http://codecov.io/github/filipebraida/ModelBasedCF.jl/coverage.svg?branch=master)](http://codecov.io/github/filipebraida/ModelBasedCF.jl?branch=master)

## Installation

The package can be installed with the Julia package manager.
From the Julia REPL, type `]` to enter the Pkg REPL mode and run:

```
pkg> add ModelBasedCF
```

Or, equivalently, via the `Pkg` API:

```julia
julia> import Pkg; Pkg.add("ModelBasedCF")
```

[contrib-url]: https://juliadocs.github.io/Documenter.jl/latest/man/contributing/

[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://juliarecsys.github.io/ModelBasedCF.jl/latest

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://juliarecsys.github.io/ModelBasedCF.jl/stable

[travis-img]: https://travis-ci.org/JuliaRecsys/ModelBasedCF.jl.svg?branch=master
[travis-url]: https://travis-ci.org/JuliaRecsys/ModelBasedCF.jl

[appveyor-img]: https://ci.appveyor.com/api/projects/status/xx7nimfpnl1r4gx0?svg=true
[appveyor-url]: https://ci.appveyor.com/project/JuliaDocs/documenter-jl

[codecov-img]: https://codecov.io/gh/JuliaRecsys/ModelBasedCF.jl/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/JuliaRecsys/ModelBasedCF.jl

[coverage-img]: https://coveralls.io/repos/JuliaRecsys/ModelBasedCF.jl/badge.svg?branch=master&service=github
[coverage-url]: https://coveralls.io/github/JuliaRecsys/ModelBasedCF.jl?branch=master

[issues-url]: https://github.com/JuliaRecsys/ModelBasedCF.jl/issues

0 comments on commit a0ff340

Please sign in to comment.