Skip to content

Commit

Permalink
Fix readme and links in the documentation(#143)
Browse files Browse the repository at this point in the history
  • Loading branch information
DAGpro committed Aug 5, 2022
1 parent f8c38c4 commit 705ab87
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 17 deletions.
32 changes: 18 additions & 14 deletions README.md
Expand Up @@ -7,25 +7,28 @@
</p>

Cycle is a PHP DataMapper ORM and Data Modelling engine designed to safely work
in classic and daemonized PHP applications such as [RoadRunner](https://github.com/spiral/roadrunner).
in classic and daemonized PHP applications such as [RoadRunner](https://github.com/roadrunner-server/roadrunner).
This package provides a convenient way to integrate Cycle ORM v2 with Yii Framework.

Read more in the [official documentation](https://cycle-orm.dev/docs/readme/2.x) \
Read more in the [official documentation](https://cycle-orm.dev/docs/readme/2.x)

[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii-cycle/v/stable.png)](https://packagist.org/packages/yiisoft/yii-cycle)
[![Total Downloads](https://poser.pugx.org/yiisoft/yii-cycle/downloads.png)](https://packagist.org/packages/yiisoft/yii-cycle)
[![Build Status](https://github.com/yiisoft/yii-cycle/workflows/build/badge.svg)](https://github.com/yiisoft/yii-cycle/actions?query=workflow%3Abuild)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yiisoft/yii-cycle/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/yii-cycle/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/yii-cycle/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/yii-cycle/?branch=master)
[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fyii-cycle%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-cycle/master)
[![static analysis](https://github.com/yiisoft/yii-cycle/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-cycle/actions?query=workflow%3A%22static+analysis%22)
[![type-coverage](https://shepherd.dev/github/yiisoft/yii-cycle/coverage.svg)](https://shepherd.dev/github/yiisoft/yii-cycle)

### Documentation
## Documentation

- [English](docs/en/README.md)
- [Russian](docs/ru/README.md)
- [Spanish](docs/es/README.md)

## Testing

### Unit testing

The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
Expand All @@ -36,10 +39,11 @@ The package is tested with [PHPUnit](https://phpunit.de/). To run tests:

### Mutation testing

The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:

```shell
./vendor/bin/infection
./vendor/bin/roave-infection-static-analysis-plugin
```

### Static analysis
Expand All @@ -50,21 +54,21 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
./vendor/bin/psalm
```

### Support the project
## License

The Yii Cycle ORM support is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).

## Support the project

[![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft)

### Follow updates
## Follow updates

[![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
[![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/yiiframework)
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)

## License

The Yii Cycle ORM support is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.

Maintained by [Yii Software](https://www.yiiframework.com/).
2 changes: 1 addition & 1 deletion docs/en/README.md
@@ -1,7 +1,7 @@
# Yii-Cycle package

Cycle is a PHP DataMapper ORM and Data Modelling engine designed to safely work in both classic and daemonized PHP
applications such as [RoadRunner](https://github.com/spiral/roadrunner).
applications such as [RoadRunner](https://github.com/roadrunner-server/roadrunner).

Read more in the [official Cycle documentation](https://cycle-orm.dev/docs/readme/2.x).

Expand Down
2 changes: 1 addition & 1 deletion docs/es/README.md
@@ -1,6 +1,6 @@
# Yii-Cycle package

`Cycle DataMapper ORM` es un motor de modelado de datos escrito en `PHP` y esta diseñado para trabajar tanto en aplicaciones `PHP` clásicas como daemonizadas tales como [RoadRunner](https://github.com/spiral/roadrunner).
`Cycle DataMapper ORM` es un motor de modelado de datos escrito en `PHP` y esta diseñado para trabajar tanto en aplicaciones `PHP` clásicas como daemonizadas tales como [RoadRunner](https://github.com/roadrunner-server/roadrunner).

Más información en la [documentación oficial de Cycle](https://cycle-orm.dev/docs/readme/2.x).

Expand Down
2 changes: 1 addition & 1 deletion docs/ru/README.md
@@ -1,7 +1,7 @@
# Пакет Yii-Cycle

Cycle — это DataMapper ORM, спроектированный для безопасной работы как в классических, так и в долгоиграющих PHP
приложениях, таких как [RoadRunner](https://github.com/spiral/roadrunner).
приложениях, таких как [RoadRunner](https://github.com/roadrunner-server/roadrunner).

Подробнее о Cycle вы можете прочесть в [официальной документации Cycle](https://cycle-orm.dev/docs/readme/2.x).

Expand Down

0 comments on commit 705ab87

Please sign in to comment.