|
1 | | -################### |
2 | | -What is CodeIgniter |
3 | | -################### |
| 1 | +######################## |
| 2 | +What is this repository? |
| 3 | +######################## |
4 | 4 |
|
5 | | -CodeIgniter is an Application Development Framework - a toolkit - for people |
6 | | -who build web sites using PHP. Its goal is to enable you to develop projects |
7 | | -much faster than you could if you were writing code from scratch, by providing |
8 | | -a rich set of libraries for commonly needed tasks, as well as a simple |
9 | | -interface and logical structure to access these libraries. CodeIgniter lets |
10 | | -you creatively focus on your project by minimizing the amount of code needed |
11 | | -for a given task. |
| 5 | +This is a fork of CodeIgniter 3, with the goal of keeping it up to date with PHP 8.2 and beyond. There is no intention to add new features or change the way CI3 works. This is purely a maintenance fork. |
12 | 6 |
|
13 | | -******************* |
14 | | -Release Information |
15 | | -******************* |
| 7 | +The original CodeIgniter 3.x branch is no longer maintained, and has not been updated to work with PHP 8.2 or newer. This fork is intended to fill that gap. |
16 | 8 |
|
17 | | -This repo contains in-development code for future releases. To download the |
18 | | -latest stable release please visit the `CodeIgniter Downloads |
19 | | -<https://codeigniter.com/download>`_ page. |
| 9 | +If the original CodeIgniter 3.x branch is updated to work with PHP 8.2 or newer, and starts to be maintained again, this fork might be retired. |
20 | 10 |
|
21 | | -************************** |
22 | | -Changelog and New Features |
23 | | -************************** |
| 11 | +**************** |
| 12 | +Issues and Pulls |
| 13 | +**************** |
24 | 14 |
|
25 | | -You can find a list of all changes for each release in the `user |
26 | | -guide change log <https://github.com/bcit-ci/CodeIgniter/blob/develop/user_guide_src/source/changelog.rst>`_. |
| 15 | +Issues and Pull Requests are welcome, but please note that this is a maintenance fork. New features will not be accepted. If you have a new feature you would like to see in CodeIgniter, please submit it to the original CodeIgniter 3.x branch. |
27 | 16 |
|
28 | 17 | ******************* |
29 | 18 | Server Requirements |
30 | 19 | ******************* |
31 | 20 |
|
32 | | -PHP version 5.6 or newer is recommended. |
33 | | - |
34 | | -It should work on 5.4.8 as well, but we strongly advise you NOT to run |
35 | | -such old versions of PHP, because of potential security and performance |
36 | | -issues, as well as missing features. |
| 21 | +PHP version 5.4 or newer, same as the original CI3 requirements. |
37 | 22 |
|
38 | 23 | ************ |
39 | 24 | Installation |
40 | 25 | ************ |
41 | 26 |
|
42 | | -Please see the `installation section <https://codeigniter.com/userguide3/installation/index.html>`_ |
43 | | -of the CodeIgniter User Guide. |
44 | | - |
45 | | -******* |
46 | | -License |
47 | | -******* |
48 | | - |
49 | | -Please see the `license |
50 | | -agreement <https://github.com/bcit-ci/CodeIgniter/blob/develop/user_guide_src/source/license.rst>`_. |
51 | | - |
52 | | -********* |
53 | | -Resources |
54 | | -********* |
55 | | - |
56 | | -- `User Guide <https://codeigniter.com/userguide3/>`_ |
57 | | -- `Contributing Guide <https://github.com/bcit-ci/CodeIgniter/blob/develop/contributing.md>`_ |
58 | | -- `Language File Translations <https://github.com/bcit-ci/codeigniter3-translations>`_ |
59 | | -- `Community Forums <https://forum.codeigniter.com/>`_ |
60 | | -- `Community Wiki <https://github.com/bcit-ci/CodeIgniter/wiki>`_ |
61 | | -- `Community Slack Channel <https://codeigniterchat.slack.com>`_ |
62 | | - |
63 | | -Report security issues to our ` Security Panel < mailto:[email protected]>`_ |
64 | | -or via our `page on HackerOne <https://hackerone.com/codeigniter>`_, thank you. |
| 27 | +Simple: Just use composer. |
65 | 28 |
|
66 | | -*************** |
67 | | -Acknowledgement |
68 | | -*************** |
| 29 | +.. code-block:: bash |
69 | 30 |
|
70 | | -The CodeIgniter team would like to thank EllisLab, all the |
71 | | -contributors to the CodeIgniter project and you, the CodeIgniter user. |
| 31 | + composer require pocketarc/codeigniter |
0 commit comments