diff --git a/README.md b/README.md
index b664aa6..a2c3751 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
-Leaf 3
+Leaf PHP
-Leaf is a PHP framework that helps you create clean, simple but powerful web apps and APIs quickly and easily. Leaf introduces a cleaner and much simpler structure to the PHP language while maintaining it's flexibility. With a simple structure and a shallow learning curve, it's an excellent way to rapidly build powerful and high performant web apps and APIs.
+Leaf is a slim and lightweight PHP framework focused on developer experience, usability, and high-performance code. It introduces a cleaner and much simpler structure to the PHP language while maintaining it's flexibility. With a simple structure and a shallow learning curve, it's an excellent way to rapidly build powerful and high performant web apps and APIs.
-## 🗂 Basic Usage
+## Basic Usage
-This is a "hello world" application created using Leaf. After [installing](#-installation) Leaf, create an _index.php_ file.
+After [installing](#installation) Leaf, create an _index.php_ file.
```php
get('/', function () {
response()->json([
- 'message' => 'Welcome!'
+ 'message' => 'Hello World!'
]);
});
@@ -56,63 +56,22 @@ leaf serve
Or with the built-in PHP server:
```bash
-php -S localhost:8000
+php -S localhost:5500
```
-## 🍁 Why Leaf?
+## Why Leaf?
When it comes to building web applications, there are numerous tools and frameworks at your disposal. Nevertheless, we are convinced that Leaf is the optimal selection for developing powerful, web applications and APIs.
-### The problems
+While PHP frameworks speed up web development, they come with challenges like a steep learning curve, potential performance overhead, and stricter code maintenance. They can be rigid, limiting flexibility, and often tie you to a specific ecosystem, making it hard to use unsupported packages. Additionally, frameworks may introduce unused code, leading to bloat and reduced performance.
-While PHP frameworks can make web development faster and more efficient, there are some potential challenges or drawbacks to using them, including:
+Leaf addresses these challenges with an easy learning curve, making it accessible to both beginners and experienced devs. It is lightweight, and boosts developer productivity by simplifying usage with global functions.
-- Learning curve: Most PHP frameworks have a steep learning curve, especially for developers who are new to the language or the framework's conventions.
-- Performance overhead: Some PHP frameworks can add unnecessary performance overhead, due to the additional abstraction layers and features they provide.
-- Code maintenance: Most frameworks require adhering to specific coding standards and conventions, which can make maintenance and updates more challenging if you are not already familiar with those standards.
-- Limited flexibility: PHP frameworks can be more rigid than writing code from scratch, as they may require you to adhere to specific coding standards and conventions. This can limit your flexibility in terms of how you structure your code and handle specific use cases.
-- Compatibility with other systems: Most PHP frameworks are bound to a particular ecosystem and make it difficult to randomly pick and use packages which don't have support for the framework you are using.
-- Packing a ton of unused code/packages: Just about every PHP framework out there adds a ton of complexity to your applications in the form of unused code, classes and packages. This in turn leads to bloat and ultimately a drop in performance
+Beyond this, Leaf is modular, allowing developers to install only necessary features while maintaining compatibility with other libraries and frameworks. Additionally, Leaf is scalable, working seamlessly from development to production with minimal configuration.
-### How Leaf tackles these
+## Installation
-Leaf 3 provides a bunch of features that aim to tackle these common problems found in just about every PHP framework out there.
-
-- #### Low barrier to entry
-
- Leaf is the easiest framework to learn with PHP newbies building powerful leaf apps in a few minutes of reading the docs/watching out tutorial videos. All you truly need to get started with Leaf is basic PHP knowledge and optional but recommended knowledge on some backend concepts like JWT auth and more.
-
-- #### Lightweight
-
- Leaf 2 was lightweight and fast enough to be considered one of the most lightweight but powerful frameworks around, and Leaf 3 makes leaf 2 look like a joke. Leaf 3 can now be considered the most lightweight PHP framework with a source of about 30kb and allows you to build full apps and APIs which end up less than 20mb including user dependencies (leaf api). This is a big haul compared to other frameworks that require dependencies and tons of files which end up more than 200mb.
-
- 
-
- > a comparison with slim - slim (left) - leaf (right)
-
-- #### Enables high developer productivity
-
- A whole lot of research and testing has been done to build amazing features which allow developers to focus on only what they need: their apps. Leaf 3 has put tons of strategies together to create the best developer experience known to PHP. From things like removing class initializers and creating global functions which allow you call classes from anywhere in your application, modules and other amazing leaf features.
-
-- #### Powered by [modules](https://leafphp.dev/modules/)
-
- Leaf 3 and its ecosystem are heavily powered by modules, which are simply pieces of leaf's functionality shipped into independently installable libraries. Modules help make leaf even more lightweight and help developers only deal with features which they need in their applications. This means that you only install what you need.
-
-- #### Easy to use features
-
- As mentioned above, a lot of research has gone into the developer experience for leaf 3 and one aspect was to make our existing features more performant and easier to use. We employed various strategies like modeling some features after popular libraries in other languages and frameworks. For instance, the API for leaf cors is almost an exact replica of the expressjs cors middleware.
-
-- #### Library/Framework compatibility
-
- Since the beginning of Leaf, we've set out to create code which could easily be integrated with other libraries and frameworks. No matter how powerful leaf is, we try to base of everything we do on simple concepts as opposed to other frameworks which need things like providers in order to access framework features in libraries.
-
-- #### Scalability
-
- One of the most beautiful things about leaf is that, no matter what package you're using with leaf, if it works in development, it will definitely work in production with near zero config, unless you want some special features. Leaf provides a core and other frameworks/libraries that build around leaf. This makes leaf appropriate for almost any project no matter it's size.
-
-## 📦 Installation
-
-You can create a Leaf 3 app with the [Leaf CLI](https://cli.leafphp.dev)
+You can create a new Leaf app using the [Leaf CLI](https://leafphp.dev/docs/cli/)
```bash
leaf create --basic
@@ -131,57 +90,22 @@ composer require leafs/leaf
| Project | Status | Description |
| ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| [leaf](https://github.com/leafsphp/leaf) | [](https://packagist.org/packages/leafs/leaf) [](https://packagist.org/packages/leafs/leaf) | Create websites and APIs quickly |
-| [leafmvc](https://github.com/leafsphp/leafmvc) | [](https://packagist.org/packages/leafs/mvc) [](https://packagist.org/packages/leafs/mvc) | An MVC wrapper for leaf (for general development) |
-| [leafapi](https://github.com/leafsphp/leafapi) | [](https://packagist.org/packages/leafs/api) [](https://packagist.org/packages/leafs/api) | An MVC wrapper for leaf geared towards API development |
-| [skeleton](https://github.com/leafsphp/skeleton) | [](https://packagist.org/packages/leafs/skeleton) [](https://packagist.org/packages/leafs/skeleton) | Leaf boilerplate for rapid development |
-| [leaf-ui](https://github.com/leafsphp/leaf-ui) | [](https://packagist.org/packages/leafs/ui) [](https://packagist.org/packages/leafs/ui) | A PHP library for building user interfaces |
+| [leafmvc](https://github.com/leafsphp/leafmvc) | [](https://packagist.org/packages/leafs/mvc) [](https://packagist.org/packages/leafs/mvc) | An MVC wrapper for leaf |
| [cli](https://github.com/leafsphp/cli) | [](https://packagist.org/packages/leafs/cli) [](https://packagist.org/packages/leafs/cli) | CLI for creating & interacting with your leaf apps |
-## 🧩 The Leaf Ecosystem (Modules)
-
-| Project | Status | Description |
-| --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
-| [alchemy](https://github.com/leafsphp/alchemy) | [](https://packagist.org/packages/leafs/alchemy) [](https://packagist.org/packages/leafs/alchemy) | A test runner for your Leaf apps |
-| [aloe](https://github.com/leafsphp/aloe) | [](https://packagist.org/packages/leafs/aloe) [](https://packagist.org/packages/leafs/aloe) | Smart console helper for leaf mvc, leaf api and skeleton |
-| [anchor](https://github.com/leafsphp/anchor) | [](https://packagist.org/packages/leafs/anchor) [](https://packagist.org/packages/leafs/anchor) | Basic security tools |
-| [auth](https://github.com/leafsphp/auth) | [](https://packagist.org/packages/leafs/auth) [](https://packagist.org/packages/leafs/auth) | Simple but powerful authentication system for your apps |
-| [bareui](https://github.com/leafsphp/bareui) | [](https://packagist.org/packages/leafs/bareui) [](https://packagist.org/packages/leafs/bareui) | Dead simple templating engine with no compilation (blazing speed) |
-| [blade](https://github.com/leafsphp/blade) | [](https://packagist.org/packages/leafs/blade) [](https://packagist.org/packages/leafs/blade) | Laravel blade templating port for leaf |
-| [cookie](https://github.com/leafsphp/cookie) | [](https://packagist.org/packages/leafs/cookie) [](https://packagist.org/packages/leafs/cookie) | Cookie management without the tears |
-| [cors](https://github.com/leafsphp/cors) | [](https://packagist.org/packages/leafs/cors) [](https://packagist.org/packages/leafs/cors) | CORS operations made simple |
-| [csrf](https://github.com/leafsphp/csrf) | [](https://packagist.org/packages/leafs/csrf) [](https://packagist.org/packages/leafs/csrf) | Basic CSRF protection |
-| [date](https://github.com/leafsphp/date) | [](https://packagist.org/packages/leafs/date) [](https://packagist.org/packages/leafs/date) | PHP dates for humans |
-| [devtools](https://github.com/leafsphp/devtools) | [](https://packagist.org/packages/leafs/devtools) [](https://packagist.org/packages/leafs/devtools) | Devtools for your Leaf app |
-| [db](https://github.com/leafsphp/db) | [](https://packagist.org/packages/leafs/db) [](https://packagist.org/packages/leafs/db) | Leaf Db from v2 (actively maintained) |
-| [db-old](https://github.com/leafsphp/db-old) | [](https://packagist.org/packages/leafs/db-old) [](https://packagist.org/packages/leafs/db-old) | Leaf Db from v1 (still maintained) |
-| [exception](https://github.com/leafsphp/exceptions) | [](https://packagist.org/packages/leafs/exception) [](https://packagist.org/packages/leafs/exception) | Leaf's exception wrapper (fork of whoops) |
-| [experiments](https://github.com/leafsphp/experimental-modules) | [](https://packagist.org/packages/leafs/experimental) [](https://packagist.org/packages/leafs/experimental) | collection of experimental modules |
-| [fetch](https://github.com/leafsphp/fetch) | [](https://packagist.org/packages/leafs/fetch) [](https://packagist.org/packages/leafs/fetch) | HTTP requests made simple |
-| [form](https://github.com/leafsphp/form) | [](https://packagist.org/packages/leafs/form) [](https://packagist.org/packages/leafs/form) | Form processes and validation |
-| [fs](https://github.com/leafsphp/fs) | [](https://packagist.org/packages/leafs/fs) [](https://packagist.org/packages/leafs/fs) | Awesome filesystem operations + file uploads |
-| [http](https://github.com/leafsphp/http) | [](https://packagist.org/packages/leafs/http) [](https://packagist.org/packages/leafs/http) | Http operations made simple (request, response, ...) |
-| [logger](https://github.com/leafsphp/logger) | [](https://packagist.org/packages/leafs/logger) [](https://packagist.org/packages/leafs/logger) | leaf logger module |
-| [mail](https://github.com/leafsphp/mail) | [](https://packagist.org/packages/leafs/mail) [](https://packagist.org/packages/leafs/mail) | Mailing made easy with leaf |
-| [mvc-core](https://github.com/leafsphp/mvc-core) | [](https://packagist.org/packages/leafs/mvc-core) [](https://packagist.org/packages/leafs/mvc-core) | Core MVC tools powering our MVC wrappers |
-| [password](https://github.com/leafsphp/password) | [](https://packagist.org/packages/leafs/password) [](https://packagist.org/packages/leafs/password) | Password encryption/validation/hashing in one box |
-| [redis](https://github.com/leafsphp/redis) | [](https://packagist.org/packages/leafs/redis) [](https://packagist.org/packages/leafs/redis) | Redis module |
-| [router](https://github.com/leafsphp/router) | [](https://packagist.org/packages/leafs/router) [](https://packagist.org/packages/leafs/router) | Default router for leaf php |
-| [session](https://github.com/leafsphp/session) | [](https://packagist.org/packages/leafs/session) [](https://packagist.org/packages/leafs/session) | PHP sessions made simple |
-| [tilly](https://github.com/leafsphp/tilly) | [](https://packagist.org/packages/leafs/tilly) [](https://packagist.org/packages/leafs/tilly) | Simple utility 'toolkit' for PHP applications |
-| [veins](https://github.com/leafsphp/veins) | [](https://packagist.org/packages/leafs/veins) [](https://packagist.org/packages/leafs/veins) | Leaf veins templating engine |
-| [viewi](https://github.com/leafsphp/viewi) | [](https://packagist.org/packages/leafs/viewi) [](https://packagist.org/packages/leafs/viewi) | Leaf integration with Viewi PHP |
+You can find a full list of all modules on the [modules documentation](https://leafphp.dev/modules/)
## 💬 Stay In Touch
-- [Twitter](https://twitter.com/leafphp)
-- [Join the forum](https://github.com/leafsphp/leaf/discussions/37)
-- [Chat on discord](https://discord.com/invite/Pkrm9NJPE3)
+- [Twitter](https://twitter.com/leafphp)
+- [Join the forum](https://github.com/leafsphp/leaf/discussions/37)
+- [Chat on discord](https://discord.com/invite/Pkrm9NJPE3)
-## 📓 Learning Leaf 3
+## 📓 Learning Leaf PHP
-- Leaf has a very easy to understand [documentation](https://leafphp.dev) which contains information on all operations in Leaf.
-- You can also check out our [youtube channel](https://www.youtube.com/channel/UCllE-GsYy10RkxBUK0HIffw) which has video tutorials on different topics
-- You can also learn from [codelabs](https://codelabs.leafphp.dev) and contribute as well.
+- Leaf has a very easy to understand [documentation](https://leafphp.dev) which contains information on all operations in Leaf.
+- You can also check out our [youtube channel](https://www.youtube.com/channel/UCllE-GsYy10RkxBUK0HIffw) which has video tutorials on different topics
+- You can also learn from [codelabs](https://leafphp.dev/codelabs/) and contribute as well.
## 😇 Contributing
@@ -191,14 +115,8 @@ To report a security vulnerability, you can reach out to [@mychidarko](https://t
## 🤩 Sponsoring Leaf
-Your cash contributions go a long way to help us make Leaf even better for you. You can sponsor Leaf and any of our packages on [open collective](https://opencollective.com/leaf) or check the [contribution page](https://leafphp.dev/support/) for a list of ways to contribute.
+We are committed to keeping Leaf open-source and free, but maintaining and developing new features now requires significant time and resources. As the project has grown, so have the costs, which have been mostly covered by the team. To sustain and grow Leaf, we need your help to support full-time maintainers.
-And to all our [existing cash/code contributors](https://leafphp.dev#sponsors), we love you all ❤️
+You can sponsor Leaf and any of our packages on [open collective](https://opencollective.com/leaf) or check the [contribution page](https://leafphp.dev/support/) for a list of ways to contribute.
-## 🤯 Links/Projects
-
-- [Leaf Docs](https://leafphp.dev)
-- [Leaf MVC](https://mvc.leafphp.dev)
-- [Leaf API](https://api.leafphp.dev)
-- [Leaf CLI](https://cli.leafphp.dev)
-- [Aloe CLI](https://leafphp.dev/aloe-cli/)
+And to all our [existing cash/code contributors](https://leafphp.dev#sponsors), we love you all ❤️