add readme file

Author: AmirHkrg

.vitepress/config.mts

@@ -11,6 +11,7 @@ export default defineConfig({
         siteTitle: 'LaraGram',
         logo: '/assets/LaraGram.svg',
         outline: 'deep',
+
         head: [
             ['link', {rel: 'icon', href: '/assets/favicon.ico'}]
         ],

src/deployment.md

@@ -12,7 +12,7 @@ The LaraGram framework has a few system requirements. You should ensure that you
 
 <div class="content-list" markdown="1">
 
-- PHP >= 8.2
+- PHP >=` 8.2`
 - Ctype PHP Extension
 - cURL PHP Extension
 - Fileinfo PHP Extension
@@ -41,34 +41,36 @@ server {
     listen 80;
     listen [::]:80;
     server_name example.com;
+    
     root /srv/example.com/public;
-
-    add_header X-Frame-Options "SAMEORIGIN";
-    add_header X-Content-Type-Options "nosniff";
-
     index index.php;
-
     charset utf-8;
+    
+    add_header X-Content-Type-Options "nosniff";
+    add_header X-Frame-Options "DENY";
+    add_header X-Robots-Tag "noindex, nofollow";
 
     location / {
-        try_files $uri $uri/ /index.php?$query_string;
+        try_files $uri /index.php$is_args$args;
     }
-
-    location = /favicon.ico { access_log off; log_not_found off; }
-    location = /robots.txt  { access_log off; log_not_found off; }
-
-    error_page 404 /index.php;
-
+    
     location ~ ^/index\.php(/|$) {
         fastcgi_pass unix:/var/run/php/php8.2-fpm.sock;
-        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
         include fastcgi_params;
         fastcgi_hide_header X-Powered-By;
     }
-
+    
+    location ~ \.php$ {
+        return 404;
+    }
+    
     location ~ /\.(?!well-known).* {
         deny all;
     }
+
+    location = /favicon.ico { access_log off; log_not_found off; }
+    location = /robots.txt  { return 403; }
 }
 ```
 

src/facades.md

@@ -168,22 +168,22 @@ Injecting a publisher implementation into the method allows us to easily test th
 
 namespace App\Models;
 
-use App\Contracts\Publisher; // [tl! remove]
-use Facades\App\Contracts\Publisher; // [tl! add]
+use App\Contracts\Publisher; // [!code --]
+use Facades\App\Contracts\Publisher; // [!code ++]
 use LaraGram\Database\Eloquent\Model;
 
 class Podcast extends Model
 {
     /**
      * Publish the podcast.
      */
-    public function publish(Publisher $publisher): void // [tl! remove]
-    public function publish(): void // [tl! add]
+    public function publish(Publisher $publisher): void // [!code --]
+    public function publish(): void // [!code ++]
     {
         $this->update(['publishing' => now()]);
 
-        $publisher->publish($this); // [tl! remove]
-        Publisher::publish($this); // [tl! add]
+        $publisher->publish($this); // [!code --]
+        Publisher::publish($this); // [!code ++]
     }
 }
 ```

src/installation.md

@@ -37,18 +37,21 @@ Before creating your first LaraGram application, make sure that your local machi
 
 If you don't have PHP and Composer installed on your local machine, the following commands will install PHP, Composer, and the LaraGram installer on macOS, Windows, or Linux:
 
-```shell tab=macOS
+::: code-group
+
+```shell [macOS]
 /bin/bash -c "$(curl -fsSL https://php.new/install/mac/8.4)"
 ```
 
-```shell tab=Windows PowerShell
+```shell [Windows PowerShell]
 # Run as administrator...
 Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://php.new/install/windows/8.4'))
 ```
 
-```shell tab=Linux
+```shell [Linux]
 /bin/bash -c "$(curl -fsSL https://php.new/install/linux/8.4)"
 ```
+:::
 
 After running one of the commands above, you should restart your terminal session. To update PHP, Composer, and the LaraGram installer after installing them via `php.new`, you can re-run the command in your terminal.
 

src/listening.md

@@ -777,7 +777,7 @@ use LaraGram\Support\Facades\RateLimiter;
 protected function boot(): void
 {
     RateLimiter::for('bot', function (Request $request) {
-        return Limit::perMinute(60)->by($request->user()?->id ?: $request->ip());
+        return Limit::perMinute(60)->by($request->user()?->id ?: user()->id);
     });
 }
 ```

src/logging.md

@@ -122,7 +122,7 @@ As mentioned previously, the `stack` driver allows you to combine multiple chann
 'channels' => [
     'stack' => [
         'driver' => 'stack',
-        'channels' => ['syslog', 'slack'], // [tl! add]
+        'channels' => ['syslog', 'slack'], // [!code ++]
         'ignore_exceptions' => false,
     ],
 

src/middleware.md

@@ -228,9 +228,14 @@ LaraGram includes predefined `bot` middleware groups that contain common middlew
 
 <div class="overflow-auto">
 
-| The `bot` Middleware Group                         |
-|----------------------------------------------------|
-| `LaraGram\Listening\Middleware\SubstituteBindings` |
+| The `bot` Middleware Group                                |
+|-----------------------------------------------------------|
+| `LaraGram\Listening\Middleware\Reply`                     |
+| `LaraGram\Listening\Middleware\Scope`                     |
+| `LaraGram\Listening\Middleware\Step`                      |
+| `LaraGram\Listening\Middleware\SubstituteBindings`        |
+| `LaraGram\Listening\Middleware\ThrottleRequests`          |
+| `LaraGram\Listening\Middleware\ThrottleRequestsWithRedis` |
 
 </div>
 

src/providers.md

@@ -163,7 +163,7 @@ When you invoke the `make:provider` Commander command, LaraGram will automatical
 
 return [
     App\Providers\AppServiceProvider::class,
-    App\Providers\ComposerServiceProvider::class, // [tl! add]
+    App\Providers\ComposerServiceProvider::class, // [!code ++]
 ];
 ```
 

src/queries.md

@@ -1563,20 +1563,20 @@ use LaraGram\Database\Query\Builder;
 use LaraGram\Support\Facades\DB;
 
 DB::table('flights')
-    ->when($destination, function (Builder $query, string $destination) { // [tl! remove]
-        $query->where('destination', $destination); // [tl! remove]
-    }) // [tl! remove]
-    ->tap(new DestinationFilter($destination)) // [tl! add]
+    ->when($destination, function (Builder $query, string $destination) { // [!code --]
+        $query->where('destination', $destination); // [!code --]
+    }) // [!code --]
+    ->tap(new DestinationFilter($destination)) // [!code ++]
     ->orderByDesc('price')
     ->get();
 
 // ...
 
 DB::table('flights')
-    ->when($destination, function (Builder $query, string $destination) { // [tl! remove]
-        $query->where('destination', $destination); // [tl! remove]
-    }) // [tl! remove]
-    ->tap(new DestinationFilter($destination)) // [tl! add]
+    ->when($destination, function (Builder $query, string $destination) { // [!code --]
+        $query->where('destination', $destination); // [!code --]
+    }) // [!code --]
+    ->tap(new DestinationFilter($destination)) // [!code ++]
     ->where('user', $request->user()->id)
     ->orderBy('destination')
     ->get();

src/requests.md

@@ -166,6 +166,7 @@ Through the Request class, you have access to all Telegram methods according to
 $request->sendMessage();
 $request->sendAnimation();
 $request->deleteMessage();
+// ...
 ```
 
 <a name="request-mode"></a>
@@ -192,7 +193,7 @@ $request->mode(64)->sendMessage();
 
 | Enum Value               | Int  |
 |--------------------------|------|
-| `Mode::CURL`             | `32` |
+| `Mode::CURL` (default)   | `32` |
 | `Mode::NO_RESPONSE_CURL` | `64` |
 
 <a name="multi-connections"></a>