Skip to content

Commit 8acc9ca

Browse files
authored
Add codeclimate badges (#7)
1 parent 0efd3ab commit 8acc9ca

File tree

5 files changed

+8
-6
lines changed

5 files changed

+8
-6
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
44
[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
5+
[![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
56
[![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
67
[![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
78
[![License](http://poser.pugx.org/phpjuice/opencf/license)](https://packagist.org/packages/phpjuice/opencf)
@@ -27,7 +28,7 @@ composer require phpjuice/opencf
2728
OpenCF Package is designed to be very simple and straightforward to use. All you have to do is:
2829

2930
1. Load a training set (dataset)
30-
3. Predict future ratings using a recommender. (Weighted Slopeone,Cosine, Weighted Cosine)
31+
2. Predict future ratings using a recommender. (Weighted Slopeone,Cosine, Weighted Cosine)
3132

3233
### Create Recommender Service
3334

@@ -107,7 +108,7 @@ This should produce the following results when using `WeightedSlopeone` recommen
107108
you can easily run tests using composer
108109

109110
```bash
110-
$ composer test
111+
composer test
111112
```
112113

113114
## Built With
@@ -145,6 +146,7 @@ license. Please see the [Licence](https://github.com/phpjuice/opencf/blob/main/L
145146

146147
![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
147148
[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
149+
[![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
148150
[![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
149151
[![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
150152
[![License](http://poser.pugx.org/phpjuice/opencf/license)](https://packagist.org/packages/phpjuice/opencf)

docs/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
44
[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
5+
[![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
56
[![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
67
[![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
78
[![License](http://poser.pugx.org/phpjuice/opencf/license)](https://packagist.org/packages/phpjuice/opencf)
@@ -13,7 +14,7 @@ PHP implementation of the (Weighted Slopeone,Cosine, Weighted Cosine) rating-bas
1314
OpenCF Package is designed to be very simple and straightforward to use. All you have to do is:
1415

1516
1. Load a training set (dataset)
16-
3. Predict future ratings using a recommender. (Weighted Slopeone,Cosine, Weighted Cosine)
17+
2. Predict future ratings using a recommender. (Weighted Slopeone,Cosine, Weighted Cosine)
1718

1819
### Create Recommender Service
1920

@@ -71,6 +72,7 @@ This should produce the following results:
7172

7273
![Tests](https://github.com/phpjuice/opencf/workflows/Tests/badge.svg?branch=main)
7374
[![Check Package](https://github.com/phpjuice/opencf/actions/workflows/cron.yml/badge.svg)](https://github.com/phpjuice/opencf/actions/workflows/cron.yml)
75+
[![Maintainability](https://api.codeclimate.com/v1/badges/60b1fac54adddd5a4e12/maintainability)](https://codeclimate.com/github/phpjuice/opencf/maintainability)
7476
[![Latest Stable Version](http://poser.pugx.org/phpjuice/opencf/v)](https://packagist.org/packages/phpjuice/opencf)
7577
[![Total Downloads](http://poser.pugx.org/phpjuice/opencf/downloads)](https://packagist.org/packages/phpjuice/opencf)
7678
[![License](http://poser.pugx.org/phpjuice/opencf/license)](https://packagist.org/packages/phpjuice/opencf)

docs/changelog.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
# Changelog
22

33
All notable changes to `opencf` are documented on [GitHub](../changelog.md)
4-

docs/questions-and-issues.md

-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@
33
Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the package? Feel free to [create an issue on GitHub](https://github.com/phpjuice/opencf/issues), we'll try to address it as soon as possible.
44

55
If you discover any security related issues, please email us at <[email protected]> instead of using the issue tracker.
6-

docs/requirements.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Requirements
22

3-
## Requirements
3+
## PHP Requirements
44

55
`phpjuice/opencf` Package requires PHP 7.4 or higher. If you are using an older version of php this package will not function correctly.
66

0 commit comments

Comments
 (0)