Skip to content

Commit 342dd3a

Browse files
authored
Merge pull request #8548 from kenjis/update-README
docs: update README
2 parents bc0517f + f1c6367 commit 342dd3a

File tree

5 files changed

+30
-26
lines changed

5 files changed

+30
-26
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ More information about the plans for version 4 can be found in [CodeIgniter 4](h
2424

2525
### Documentation
2626

27-
The [User Guide](https://codeigniter4.github.io/userguide/) is the primary documentation for CodeIgniter 4.
27+
The [User Guide](https://codeigniter.com/user_guide/) is the primary documentation for CodeIgniter 4.
2828

29-
The current **in-progress** User Guide can be found [here](https://codeigniter4.github.io/CodeIgniter4/).
29+
You will also find the [current **in-progress** User Guide](https://codeigniter4.github.io/CodeIgniter4/).
3030
As with the rest of the framework, it is a work in progress, and will see changes over time to structure, explanations, etc.
3131

3232
You might also be interested in the [API documentation](https://codeigniter4.github.io/api/) for the framework components.
3333

3434
## Important Change with index.php
3535

36-
index.php is no longer in the root of the project! It has been moved inside the *public* folder,
36+
`index.php` is no longer in the root of the project! It has been moved inside the *public* folder,
3737
for better security and separation of components.
3838

3939
This means that you should configure your web server to "point" to your project's *public* folder, and
@@ -48,9 +48,10 @@ CodeIgniter is developed completely on a volunteer basis. As such, please give u
4848
for your issues to be reviewed. If you haven't heard from one of the team in that time period,
4949
feel free to leave a comment on the issue so that it gets brought back to our attention.
5050

51-
We use GitHub issues to track **BUGS** and to track approved **DEVELOPMENT** work packages.
52-
We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss
53-
FEATURE REQUESTS.
51+
> [!IMPORTANT]
52+
> We use GitHub issues to track **BUGS** and to track approved **DEVELOPMENT** work packages.
53+
> We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss
54+
> FEATURE REQUESTS.
5455
5556
If you raise an issue here that pertains to support or a feature request, it will
5657
be closed! If you are not sure if you have found a bug, raise a thread on the forum first -
@@ -91,10 +92,11 @@ PHP version 7.4 or higher is required, with the following extensions installed:
9192
- [intl](http://php.net/manual/en/intl.requirements.php)
9293
- [mbstring](http://php.net/manual/en/mbstring.installation.php)
9394

94-
> **Warning**
95-
> The end of life date for PHP 7.4 was November 28, 2022. If you are
96-
> still using PHP 7.4, you should upgrade immediately. The end of life date
97-
> for PHP 8.0 will be November 26, 2023.
95+
> [!WARNING]
96+
> The end of life date for PHP 7.4 was November 28, 2022.
97+
> The end of life date for PHP 8.0 was November 26, 2023.
98+
> If you are still using PHP 7.4 or 8.0, you should upgrade immediately.
99+
> The end of life date for PHP 8.1 will be November 25, 2024.
98100
99101
Additionally, make sure that the following extensions are enabled in your PHP:
100102

admin/framework/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ It has been built from the
1111

1212
More information about the plans for version 4 can be found in [CodeIgniter 4](https://forum.codeigniter.com/forumdisplay.php?fid=28) on the forums.
1313

14-
The user guide corresponding to the latest version of the framework can be found
15-
[here](https://codeigniter4.github.io/userguide/).
14+
You can read the [user guide](https://codeigniter.com/user_guide/)
15+
corresponding to the latest version of the framework.
1616

1717
## Important Change with index.php
1818

@@ -47,10 +47,11 @@ PHP version 7.4 or higher is required, with the following extensions installed:
4747
- [intl](http://php.net/manual/en/intl.requirements.php)
4848
- [mbstring](http://php.net/manual/en/mbstring.installation.php)
4949

50-
> **Warning**
51-
> The end of life date for PHP 7.4 was November 28, 2022. If you are
52-
> still using PHP 7.4, you should upgrade immediately. The end of life date
53-
> for PHP 8.0 will be November 26, 2023.
50+
> [!WARNING]
51+
> The end of life date for PHP 7.4 was November 28, 2022.
52+
> The end of life date for PHP 8.0 was November 26, 2023.
53+
> If you are still using PHP 7.4 or 8.0, you should upgrade immediately.
54+
> The end of life date for PHP 8.1 will be November 25, 2024.
5455
5556
Additionally, make sure that the following extensions are enabled in your PHP:
5657

admin/starter/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ It has been built from the
1111

1212
More information about the plans for version 4 can be found in [CodeIgniter 4](https://forum.codeigniter.com/forumdisplay.php?fid=28) on the forums.
1313

14-
The user guide corresponding to the latest version of the framework can be found
15-
[here](https://codeigniter4.github.io/userguide/).
14+
You can read the [user guide](https://codeigniter.com/user_guide/)
15+
corresponding to the latest version of the framework.
1616

1717
## Installation & updates
1818

@@ -55,10 +55,11 @@ PHP version 7.4 or higher is required, with the following extensions installed:
5555
- [intl](http://php.net/manual/en/intl.requirements.php)
5656
- [mbstring](http://php.net/manual/en/mbstring.installation.php)
5757

58-
> **Warning**
59-
> The end of life date for PHP 7.4 was November 28, 2022. If you are
60-
> still using PHP 7.4, you should upgrade immediately. The end of life date
61-
> for PHP 8.0 will be November 26, 2023.
58+
> [!WARNING]
59+
> The end of life date for PHP 7.4 was November 28, 2022.
60+
> The end of life date for PHP 8.0 was November 26, 2023.
61+
> If you are still using PHP 7.4 or 8.0, you should upgrade immediately.
62+
> The end of life date for PHP 8.1 will be November 25, 2024.
6263
6364
Additionally, make sure that the following extensions are enabled in your PHP:
6465

admin/starter/tests/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use to test your application. Those details can be found in the documentation.
77

88
## Resources
99

10-
* [CodeIgniter 4 User Guide on Testing](https://codeigniter4.github.io/userguide/testing/index.html)
10+
* [CodeIgniter 4 User Guide on Testing](https://codeigniter.com/user_guide/testing/index.html)
1111
* [PHPUnit docs](https://phpunit.de/documentation.html)
1212
* [Any tutorials on Unit testing in CI4?](https://forum.codeigniter.com/showthread.php?tid=81830)
1313

@@ -38,7 +38,7 @@ In order to set up the database edit the details for the `tests` group in
3838
**app/Config/Database.php** or **.env**.
3939
Make sure that you provide a database engine that is currently running on your machine.
4040
More details on a test database setup are in the
41-
[Testing Your Database](https://codeigniter4.github.io/userguide/testing/database.html) section of the documentation.
41+
[Testing Your Database](https://codeigniter.com/user_guide/testing/database.html) section of the documentation.
4242

4343
## Running the tests
4444

@@ -114,5 +114,5 @@ Review the links above and always pay attention to your code coverage.
114114
Tests can include migrating, seeding, and testing against a mock or live database.
115115
Be sure to modify the test case (or create your own) to point to your seed and migrations
116116
and include any additional steps to be run before tests in the `setUp()` method.
117-
See [Testing Your Database](https://codeigniter4.github.io/userguide/testing/database.html)
117+
See [Testing Your Database](https://codeigniter.com/user_guide/testing/database.html)
118118
for details.

tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use to test your application. Those details can be found in the documentation.
77

88
## Resources
99

10-
* [CodeIgniter 4 User Guide on Testing](https://codeigniter4.github.io/userguide/testing/index.html)
10+
* [CodeIgniter 4 User Guide on Testing](https://codeigniter.com/user_guide/testing/index.html)
1111
* [PHPUnit docs](https://phpunit.de/documentation.html)
1212
* [Any tutorials on Unit testing in CI4?](https://forum.codeigniter.com/showthread.php?tid=81830)
1313

0 commit comments

Comments
 (0)