From 435efece4affdd83167f033db8aa85a1f9bfd27f Mon Sep 17 00:00:00 2001
From: Pranjal Pandey <pranjaltech10@gmail.com>
Date: Fri, 18 Oct 2024 00:10:43 +0530
Subject: [PATCH] Create README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..24d51f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+<div align="center">
+<img src="https://user-images.githubusercontent.com/7591484/170873489-6aa40fe3-9d5c-476b-9434-f12f0a896c85.png" width="20%">
+
+<h1> Scrawler MVC </h1>
+
+<a href="https://github.com/scrawler-labs/app/actions/workflows/main.yml"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/scrawler-labs/app/main.yml?style=flat-square">
+</a>
+[![Codecov](https://img.shields.io/codecov/c/gh/scrawler-labs/app?style=flat-square)](https://app.codecov.io/gh/scrawler-labs/app)
+[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/quality/g/scrawler-labs/app?style=flat-square)](https://scrutinizer-ci.com/g/scrawler-labs/app/?branch=main)
+<a href="[https://github.com/scrawler-labs/app/actions/workflows/main.yml](https://github.com/scrawler-labs/app/actions/workflows/main.yml)"><img src="https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square" alt="PHPStan Enabled"></a>
+[![Packagist Version](https://img.shields.io/packagist/v/scrawler/app?style=flat-square)](https://packagist.org/packages/scrawler/app)
+[![Packagist License](https://img.shields.io/packagist/l/scrawler/app?style=flat-square)](https://packagist.org/packages/scrawler/app)
+
+<br>
+
+🔥Create simple but powerful web apps and APIs quickly, with minumum lines of code🔥<br>
+🇮🇳 Made in India 🇮🇳
+</div>
+
+## 💻 Installation
+You can install Scrawler App via Composer. If you don't have composer installed , you can download composer from [here](https://getcomposer.org/download/)
+
+or if you want to start with an mvc template
+```sh
+composer create-project scrawler/mvc <project-name>
+```
+
+## ✨ Folder Structure
+- `assets`: your css and js assets live here
+- `config`: global configuration files, you can add your own configurations here
+- `storage`: app caches , file storage stays here
+- `tests`: pest tests for your app lives here
+- `src`
+  - `Controllers`: auto routed controller classes live here
+  - `views`: blade view files live here
+  - `boot.php`: boots the framework and register the required services , do not modify
+  - `app.php`: you can register your services and configuration here
+  - `routes.php`: manual routes can be added here if required
+