🔀 Merge pull request #124 from mychidarko/v3.x-dev

Update Readme
leafsphp · Apr 18, 2022 · a30e44e · a30e44e
2 parents 4ebdc03 + 07cab2a
commit a30e44e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 12 deletions.
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
@@ -20,4 +20,4 @@ jobs:
             - name: Commit changes
               uses: stefanzweifel/git-auto-commit-action@v4
               with:
-                  commit_message: Fix styling
+                  commit_message: 👷 Fix styling
diff --git a/README.md b/README.md
@@ -30,21 +30,21 @@ leaf create <project-name> --v3 --basic
 You can also use [Composer](https://getcomposer.org/) to install Leaf 3 in your project quickly.
 
 ```bash
-composer require leafs/leaf v3.0-beta
+composer require leafs/leaf
 ```
 
 **Install Leaf 2:**
 
 Since leaf 3 is still in beta, you might want to install the stable leaf 2 instead. You can do this with Leaf CLI or composer.
 
 ```sh
-leaf create <project-name> --basic
+leaf create <project-name> --basic --v2
 ```
 
 Or with composer
 
 ```sh
-composer require leafs/leaf
+composer require leafs/leaf v2.6
 ```
 
 ## 🗂 Basic Usage
@@ -57,7 +57,6 @@ After [installing](#installation) Leaf, create an _index.php_ file.
 
 require __DIR__ . "/vendor/autoload.php";
 
-// Base example
 app()->get("/", function () {
   response()->json([
     "message" => "Welcome!"
@@ -71,11 +70,17 @@ app()->run();
 
 You may quickly test this using the built-in PHP server:
 
-```bash
+```sh
 php -S localhost:8000
 ```
 
-**You can view the full documentation [here](https://leafphp.netlify.app/#/)**
+Or with the Leaf CLI:
+
+```sh
+leaf serve
+```
+
+**You can view the full documentation [here](https://leafphp.dev/)**
 
 ## ✈️ The Leaf Ecosystem (Libs & Frameworks)
 
@@ -86,7 +91,7 @@ php -S localhost:8000
 | [leafapi](https://github.com/leafsphp/leafapi)  | [![Latest Stable Version](https://poser.pugx.org/leafs/api/v/stable)](https://packagist.org/packages/leafs/api) [![Total Downloads](https://poser.pugx.org/leafs/api/downloads)](https://packagist.org/packages/leafs/api)                     | An MVC wrapper for leaf geared towards API development |
 | [skeleton](https://github.com/leafsphp/skeleton) | [![Latest Stable Version](https://poser.pugx.org/leafs/skeleton/v/stable)](https://packagist.org/packages/leafs/skeleton) [![Total Downloads](https://poser.pugx.org/leafs/skeleton/downloads)](https://packagist.org/packages/leafs/skeleton) | Leaf boilerplate for rapid development                 |
 | [leaf-ui](https://github.com/leafsphp/leaf-ui)  | [![Latest Stable Version](https://poser.pugx.org/leafs/ui/v/stable)](https://packagist.org/packages/leafs/ui) [![Total Downloads](https://poser.pugx.org/leafs/ui/downloads)](https://packagist.org/packages/leafs/ui)                         | A PHP library for building user interfaces             |
-| [cli](https://github.com/leafsphp/cli)      | [![Latest Stable Version](https://poser.pugx.org/leafs/cli/v/stable)](https://packagist.org/packages/leafs/cli) [![Total Downloads](https://poser.pugx.org/leafs/cli/downloads)](https://packagist.org/packages/leafs/cli)                     | CLI for interacting with your leaf apps                |
+| [cli](https://github.com/leafsphp/cli)      | [![Latest Stable Version](https://poser.pugx.org/leafs/cli/v/stable)](https://packagist.org/packages/leafs/cli) [![Total Downloads](https://poser.pugx.org/leafs/cli/downloads)](https://packagist.org/packages/leafs/cli)                     | CLI for creating & interacting with your leaf apps                |
 
 ## 🧩 The Leaf Ecosystem (Modules)
 
@@ -103,16 +108,18 @@ php -S localhost:8000
 | [db](https://github.com/leafsphp/db)                   | [![Latest Stable Version](https://poser.pugx.org/leafs/db/v/stable)](https://packagist.org/packages/leafs/db) [![Total Downloads](https://poser.pugx.org/leafs/db/downloads)](https://packagist.org/packages/leafs/db)                                         | Leaf Db from v2 (actively maintained)                             |
 | [session](https://github.com/leafsphp/session)              | [![Latest Stable Version](https://poser.pugx.org/leafs/session/v/stable)](https://packagist.org/packages/leafs/session) [![Total Downloads](https://poser.pugx.org/leafs/session/downloads)](https://packagist.org/packages/leafs/session)                     | PHP sessions made simple                                          |
 | [cookie](https://github.com/leafsphp/cookie)               | [![Latest Stable Version](https://poser.pugx.org/leafs/cookie/v/stable)](https://packagist.org/packages/leafs/cookie) [![Total Downloads](https://poser.pugx.org/leafs/cookie/downloads)](https://packagist.org/packages/leafs/cookie)                         | Cookie management without the tears                               |
+| [http](https://github.com/leafsphp/http)                 | [![Latest Stable Version](https://poser.pugx.org/leafs/http/v/stable)](https://packagist.org/packages/leafs/http) [![Total Downloads](https://poser.pugx.org/leafs/http/downloads)](https://packagist.org/packages/leafs/http)                                 | Http operations made simple (request, response, ...)              |
+| [cors](https://github.com/leafsphp/cors)                 | [![Latest Stable Version](https://poser.pugx.org/leafs/cors/v/stable)](https://packagist.org/packages/leafs/cors) [![Total Downloads](https://poser.pugx.org/leafs/cors/downloads)](https://packagist.org/packages/leafs/cors)                                 | CORS operations made simple          |
+| [csrf](https://github.com/leafsphp/csrf)               | [![Latest Stable Version](https://poser.pugx.org/leafs/csrf/v/stable)](https://packagist.org/packages/leafs/csrf) [![Total Downloads](https://poser.pugx.org/leafs/csrf/downloads)](https://packagist.org/packages/leafs/csrf)                         | Basic CSRF protection                                              |
+| [anchor](https://github.com/leafsphp/anchor)               | [![Latest Stable Version](https://poser.pugx.org/leafs/anchor/v/stable)](https://packagist.org/packages/leafs/anchor) [![Total Downloads](https://poser.pugx.org/leafs/anchor/downloads)](https://packagist.org/packages/leafs/anchor)                         | Basic security tools                                              |
 | [logger](https://github.com/leafsphp/logger)                   | [![Latest Stable Version](https://poser.pugx.org/leafs/logger/v/stable)](https://packagist.org/packages/leafs/logger) [![Total Downloads](https://poser.pugx.org/leafs/logger/downloads)](https://packagist.org/packages/leafs/logger)                                         | leaf logger module                     |
 | [fs](https://github.com/leafsphp/fs)                   | [![Latest Stable Version](https://poser.pugx.org/leafs/fs/v/stable)](https://packagist.org/packages/leafs/fs) [![Total Downloads](https://poser.pugx.org/leafs/fs/downloads)](https://packagist.org/packages/leafs/fs)                                         | Awesome filesystem operations + file uploads                      |
 | [date](https://github.com/leafsphp/date)                 | [![Latest Stable Version](https://poser.pugx.org/leafs/date/v/stable)](https://packagist.org/packages/leafs/date) [![Total Downloads](https://poser.pugx.org/leafs/date/downloads)](https://packagist.org/packages/leafs/date)                                 | PHP dates for humans                                              |
 | [bareui](https://github.com/leafsphp/bareui)               | [![Latest Stable Version](https://poser.pugx.org/leafs/bareui/v/stable)](https://packagist.org/packages/leafs/bareui) [![Total Downloads](https://poser.pugx.org/leafs/bareui/downloads)](https://packagist.org/packages/leafs/bareui)                         | Dead simple templating engine with no compilation (blazing speed) |
 | [blade](https://github.com/leafsphp/blade)                | [![Latest Stable Version](https://poser.pugx.org/leafs/blade/v/stable)](https://packagist.org/packages/leafs/blade) [![Total Downloads](https://poser.pugx.org/leafs/blade/downloads)](https://packagist.org/packages/leafs/blade)                             | Laravel blade templating port for leaf                            |
 | [veins](https://github.com/leafsphp/veins)                | [![Latest Stable Version](https://poser.pugx.org/leafs/veins/v/stable)](https://packagist.org/packages/leafs/veins) [![Total Downloads](https://poser.pugx.org/leafs/veins/downloads)](https://packagist.org/packages/leafs/veins)                             | Leaf veins templating engine                                      |
-| [http](https://github.com/leafsphp/http)                 | [![Latest Stable Version](https://poser.pugx.org/leafs/http/v/stable)](https://packagist.org/packages/leafs/http) [![Total Downloads](https://poser.pugx.org/leafs/http/downloads)](https://packagist.org/packages/leafs/http)                                 | Http operations made simple (request, response, ...)              |
-| [anchor](https://github.com/leafsphp/anchor)               | [![Latest Stable Version](https://poser.pugx.org/leafs/anchor/v/stable)](https://packagist.org/packages/leafs/anchor) [![Total Downloads](https://poser.pugx.org/leafs/anchor/downloads)](https://packagist.org/packages/leafs/anchor)                         | Basic security tools                                              |
 | [mvc-core](https://github.com/leafsphp/mvc-core)             | [![Latest Stable Version](https://poser.pugx.org/leafs/mvc-core/v/stable)](https://packagist.org/packages/leafs/mvc-core) [![Total Downloads](https://poser.pugx.org/leafs/mvc-core/downloads)](https://packagist.org/packages/leafs/mvc-core)                 | Core MVC tools powering our MVC wrappers                          |
-| [aloe](https://github.com/leafsphp/aloe)                 | [![Latest Stable Version](https://poser.pugx.org/leafs/aloe/v/stable)](https://packagist.org/packages/leafs/aloe) [![Total Downloads](https://poser.pugx.org/leafs/aloe/downloads)](https://packagist.org/packages/leafs/aloe)                                 | Overpowered cli for our MVC wrappers                              |
+| [exception](https://github.com/leafsphp/exceptions)                 | [![Latest Stable Version](https://poser.pugx.org/leafs/exception/v/stable)](https://packagist.org/packages/leafs/exception) [![Total Downloads](https://poser.pugx.org/leafs/exception/downloads)](https://packagist.org/packages/leafs/exception)    | Leaf's exception wrapper (fork of whoops)                           |
 | [fetch](https://github.com/leafsphp/fetch)                | [![Latest Stable Version](https://poser.pugx.org/leafs/fetch/v/stable)](https://packagist.org/packages/leafs/fetch) [![Total Downloads](https://poser.pugx.org/leafs/fetch/downloads)](https://packagist.org/packages/leafs/fetch)                             | HTTP requests made simple                                         |
 | [redis](https://github.com/leafsphp/redis)                | [![Latest Stable Version](https://poser.pugx.org/leafs/redis/v/stable)](https://packagist.org/packages/leafs/redis) [![Total Downloads](https://poser.pugx.org/leafs/redis/downloads)](https://packagist.org/packages/leafs/redis)                             | Redis module                                                      |
 
@@ -126,7 +133,7 @@ php -S localhost:8000
 
 - 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
-- We are also working on codelabs which will bring hands-on tutorials you can follow and contribute to.
+- You can also learn from [codelabs](https://codelabs.leafphp.dev) and contribute as well.
 
 ## 😇 Contributing
 
@@ -225,6 +232,17 @@ And to all our existing cash/code contributors, we love you all ❤️
 				<sub><b>Vano</b></sub>
 			</a>
 		</td>
+		<td align="center">
+          <a href="#">
+            <img
+              src="https://images.opencollective.com/guest-c72a498e/avatar.png"
+              width="120px"
+              alt=""
+            />
+            <br />
+            <sub><b>Casprine</b></sub>
+          </a>
+        </td>
 	</tr>
 </table>