Skip to content

Commit dbb9842

Browse files
committed
chore: update readme
1 parent 99c1e62 commit dbb9842

File tree

1 file changed

+16
-46
lines changed

1 file changed

+16
-46
lines changed

README.MD

Lines changed: 16 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,27 @@
11
<p align="center">
2-
<br><br>
3-
<img src="https://leafphp.dev/logo-circle.png" height="100"/>
4-
<br><br>
2+
<a href="https://leafphp.dev" target="_blank">
3+
<img src="https://leafphp.dev/logo-circle.png" height="100" alt="Leaf Logo">
4+
</a>
5+
<h1 align="center">Leaf MVC</h1>
56
</p>
67

7-
# Leaf MVC 4.0
8-
9-
[![Latest Stable Version](https://poser.pugx.org/leafs/mvc/v/stable)](https://packagist.org/packages/leafs/mvc)
10-
[![Total Downloads](https://poser.pugx.org/leafs/mvc/downloads)](https://packagist.org/packages/leafs/mvc)
11-
[![License](https://poser.pugx.org/leafs/mvc/license)](https://packagist.org/packages/leafs/mvc)
8+
<p align="center">
9+
<a href="https://packagist.org/packages/leafs/mvc"><img src="https://img.shields.io/packagist/dt/leafs/mvc" alt="Total Downloads"></a>
10+
<a href="https://packagist.org/packages/leafs/leaf"><img src="https://poser.pugx.org/leafs/mvc/v/stable" alt="Latest Stable Version"></a>
11+
<a href="https://packagist.org/packages/leafs/leaf"><img src="https://poser.pugx.org/leafs/mvc/license" alt="License"></a>
12+
</p>
1213

13-
Leaf MVC is a lightweight but feature-rich MVC framework built on top of [leaf php](https://leafphp.dev). It gives you the simplicity of Leaf and it's modules with the structure of an MVC framework. Leaf MVC is a great choice for building applications that scale without the complexity of most modern frameworks.
14+
Leaf MVC is a lightweight but feature-rich MVC framework built on top of [leaf php](https://leafphp.dev). It gives you the structure and tools of larger frameworks like Laravel and Ruby on Rails with the simplicity and elegance of Leaf.
1415

15-
## 📦 Installation
16+
## 📦 Setting up
1617

1718
You can install Leaf MVC with the [Leaf CLI](https://cli.leafphp.dev)
1819

1920
```sh
2021
leaf create <project-name> --mvc
2122
```
2223

23-
Or for a more personalized installation, you can add `--custom` to the command
24-
25-
```sh
26-
leaf create <project-name> --mvc --custom
27-
```
28-
29-
You can also use [Composer](https://getcomposer.org/) if you don't want to use the Leaf CLI, although we recommend using the CLI for a better experience:
30-
31-
```bash
32-
composer create-project leafs/mvc <project-name>
33-
```
34-
35-
Note that `<project-name>` is the name of the project you want to create, and that will be your folder name. You can also use `.` to install in the current directory.
36-
37-
## 🗂 Directory Structure
38-
39-
```bash
40-
C:.
41-
├───app
42-
│ ├───controllers
43-
│ ├───database
44-
│ ├───models
45-
│ ├───routes
46-
│ └───views
47-
│ ├───css
48-
│ └───errors
49-
├───public
50-
│ └───assets
51-
│ ├───css
52-
│ └───img
53-
└───vendor
54-
```
55-
56-
This directory structure is our opinionated way of organizing your MVC application. It is a blend of the best practices from different frameworks like Ruby on Rails and Laravel and some of our own experience building applications.
24+
This will scaffold a basic MVC application and set up your environment for you. You can add features like authentication, database migrations, and more with the Leaf CLI. Find the full documentation on the [Leaf website](https://leafphp.dev/docs/mvc/).
5725

5826
To run your Leaf MVC application, use
5927

@@ -75,8 +43,10 @@ To report a security vulnerability, you can reach out to [@mychidarko](https://t
7543

7644
## 🤩 Sponsoring Leaf
7745

78-
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.
46+
Leaf has always been open-source and free, but as the project grows, so do the challenges of maintaining and building new features. The costs—time, resources, and infrastructure—are increasing rapidly, and our small team can no longer sustain this alone.
47+
48+
To keep Leaf alive and thriving, we need your support now more than ever. Sponsor us on [GitHub Sponsors](https://github.com/sponsors/leafsphp) or visit our [sponsors page](https://leafphp.dev/support/) to explore ways you can contribute.
7949

80-
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.
50+
Your help makes all the difference—let’s keep Leaf moving forward together!
8151

8252
And to all our [existing cash/code contributors](https://leafphp.dev#sponsors), we love you all ❤️

0 commit comments

Comments
 (0)