Changed: Updated README.md

README.md

@@ -1,4 +1,52 @@
-# Framework
-
 > [!WARNING]
 > The framework does not yet have a stable version. It is still under development.
+
+![License](https://img.shields.io/github/license/zaphyr-org/framework?style=for-the-badge)
+![Version](https://img.shields.io/packagist/v/zaphyr-org/framework?style=for-the-badge)
+![Downloads](https://img.shields.io/packagist/dt/zaphyr-org/framework?style=for-the-badge)
+![Stars](https://img.shields.io/github/stars/zaphyr-org/framework?style=for-the-badge)
+![Issues](https://img.shields.io/github/issues/zaphyr-org/framework?style=for-the-badge)
+
+# Framework
+
+A PHP framework based on ZAPHYR repositories.
+
+## System Requirements
+
+You need `PHP => 8.1.0` but the latest stable version of PHP is recommended.
+
+## Installation
+
+It's recommended that you use [Composer](https://getcomposer.org/) to install the framework repository.
+
+```console
+composer require zaphyr-org/framework
+```
+
+## Documentation
+
+You can read the full documentation [here](https://zaphyr.org/docs/framework/latest/welcome).
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Issues
+
+Bug reports and feature requests can be submitted on the [GitHub Issue Tracker](https://github.com/zaphyr-org/framework/issues).
+
+## Security
+
+If you discover security related issues, please email security@zaphyr.org **instead of using the issue tracker!**
+
+## Contributing
+
+Please see [CONTRIBUTING](https://zaphyr.org/docs/contributing) for details.
+
+## Code of Conduct
+
+Please see [CODE OF CONDUCT](https://zaphyr.org/docs/code-of-conduct) for details.
+
+## License
+
+This project is licensed under the MIT license. See [LICENSE](LICENSE.md) for more information.