diff --git a/LICENSE.md b/LICENSE.md index bc5674fe..6a920d60 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,17 +1,17 @@ -Copyright © 2008 by Yii Software (https://www.yiiframework.com/) +Copyright © 2008 by Yii Software () All rights reserved. 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. diff --git a/README.md b/README.md index 8ee37330..b1342bea 100644 --- a/README.md +++ b/README.md @@ -40,15 +40,26 @@ The package could be installed via composer: composer require yiisoft/db-sqlite ``` -## Usage +## Documentation -For config connection to SQLite database check [Connecting SQLite](https://github.com/yiisoft/db/blob/master/docs/en/connection/sqlite.md). +English: -[Check the documentation docs](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. +- For config connection to SQLite database check [Connecting SQLite](https://github.com/yiisoft/db/blob/master/docs/en/connection/sqlite.md) +- [Check the yiisoft/db docs](https://github.com/yiisoft/db/blob/master/docs/en/README.md) to learn about usage. -## Testing +Português - Brasil: -[Check the documentation](/docs/en/testing.md) to learn about testing. +- Para configurar a conexão com o SQLite leia [Connecting SQLite](https://github.com/yiisoft/db/blob/master/docs/pt-BR/connection/sqlite.md). +- [Confira a documentação](https://github.com/yiisoft/db/blob/master/docs/pt-BR/README.md) para aprender como usar. + +Testing: + +- [Internals](docs/internals.md) + +## Support + +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). ## Support the project diff --git a/composer.json b/composer.json index 1130051a..94622861 100644 --- a/composer.json +++ b/composer.json @@ -18,7 +18,7 @@ "forum": "https://www.yiiframework.com/forum/", "wiki": "https://www.yiiframework.com/wiki/", "chat": "https://t.me/yii3en", - "irc": "irc://irc.freenode.net/yii" + "irc": "ircs://irc.libera.chat:6697/yii" }, "require": { "php": "^8.0", diff --git a/docs/internals.md b/docs/internals.md index 30ec7ee4..4966a62b 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -6,12 +6,39 @@ All our packages have github actions by default, so you can test your [contribut > Note: We recommend pull requesting in draft mode until all tests pass. +## Docker image + +For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder. + +1. [MySQL 8](../../../docker-compose.yml) +2. [MariaDB 10.11](../../../docker-compose-mariadb.yml) + +For running the docker containers you can use the following command: + +MySQL 8.0. + +```dockerfile +docker compose up -d +``` + +MariaDB 10.11. + +```dockerfile +docker compose -f docker-compose-mariadb.yml up -d +``` + ## Unit testing -The package is tested with [PHPUnit](https://phpunit.de/). To run tests: +The package is tested with [PHPUnit](https://phpunit.de/). + +The following steps are required to run the tests: + +1. Run the docker container for the dbms. +2. Install the dependencies of the project with composer. +3. Run the tests. ```shell -./vendor/bin/phpunit +vendor/bin/phpunit ``` ## Mutation testing diff --git a/phpunit.xml.dist b/phpunit.xml.dist index c65978bb..368ef3ec 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,5 +1,5 @@ - +