Skip to content

Commit

Permalink
Fix docs (#213)
Browse files Browse the repository at this point in the history
Co-authored-by: Sergei Predvoditelev <[email protected]>
  • Loading branch information
luizcmarin and vjik authored May 15, 2024
1 parent 9e95e42 commit 7a896ef
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 11 deletions.
6 changes: 3 additions & 3 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

* Redistributions of source code must retain the above copyright
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Yii Software nor the names of its
* Neither the name of Yii Software nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.

Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@
<br>
</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:/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)

[![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:/yiisoft/yii-cycle/workflows/build/badge.svg)](https:/yiisoft/yii-cycle/actions?query=workflow%3Abuild)
Expand All @@ -20,11 +14,20 @@ Read more in the [official documentation](https://cycle-orm.dev/docs/readme/2.x)
[![static analysis](https:/yiisoft/yii-cycle/workflows/static%20analysis/badge.svg)](https:/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)

Cycle is a PHP DataMapper ORM and Data Modelling engine designed to safely work
in classic and daemonized PHP applications such as [RoadRunner](https:/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)

## Documentation

- Guide: [English](docs/guide/en), [Russian](docs/guide/ru), [Spanish](docs/guide/es)
- Guide: [English](docs/guide/en/README.md), [Português - Brasil](docs/guide/pt-BR/README.md), [Русский](docs/guide/ru/README.md), [Spanish](docs/guide/es/README.md)
- [Internals](docs/internals.md)

If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).

## License

The Yii Cycle ORM support is free software. It is released under the terms of the BSD License.
Expand Down
6 changes: 5 additions & 1 deletion docs/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,8 @@ use either newest or any specific version of PHP:
## Dependencies

Use [ComposerRequireChecker](https:/maglnet/ComposerRequireChecker) to detect transitive
[Composer](https://getcomposer.org/) dependencies.
[Composer](https://getcomposer.org) dependencies:

```shell
./vendor/bin/composer-require-checker
```

0 comments on commit 7a896ef

Please sign in to comment.