From 4b1ff247c035045eeb3b3099e4719d238906051d Mon Sep 17 00:00:00 2001
From: Tan Nguyen <tannp27@gmail.com>
Date: Sun, 28 Jul 2024 21:20:04 +0700
Subject: [PATCH] Update README.md

---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 40 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1aa3d90..73869d1 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,43 @@
-# blog-core
+# Blog Core Package for CSlant Blog 👋
+
+<p align="center">
+<a href="#"><img src="https://img.shields.io/github/license/cslant/blog-core.svg?style=flat-square" alt="License"></a>
+<a href="https://packagist.org/packages/cslant/blog-core"><img src="https://img.shields.io/github/release/cslant/blog-core.svg?style=flat-square" alt="Latest Version"></a>
+    <a href="https://github.com/cslant/blog-core/actions/workflows/setup_test.yml"><img src="https://img.shields.io/github/actions/workflow/status/cslant/blog-core/setup_test.yml?label=tests&branch=main" alt="Test Status"></a>
+<a href="https://scrutinizer-ci.com/g/cslant/blog-core"><img src="https://img.shields.io/scrutinizer/g/cslant/blog-core.svg?style=flat-square" alt="Quality Score"></a>
+<a href="https://codeclimate.com/github/cslant/blog-core/maintainability"><img src="https://api.codeclimate.com/v1/badges/429b59aad9584bad7ff6/maintainability"  alt="Maintainability"/></a>
+</p>
+
+```text
+      ____ ____  _        _    _   _ _____   ____  _     ___   ____
+     / ___/ ___|| |      / \  | \ | |_   _| | __ )| |   / _ \ / ___|
+    | |   \___ \| |     / _ \ |  \| | | |   |  _ \| |  | | | | |  _
+    | |___ ___) | |___ / ___ \| |\  | | |   | |_) | |__| |_| | |_| |
+     \____|____/|_____/_/   \_\_| \_| |_|   |____/|_____\___/ \____|
+ ```
+
+This is a package for CSlant's blog Core.
+
+## 📋 Requirements
+
+- PHP ^8.1
+- [Composer](https://getcomposer.org/)
+
+
+## 🔧 Installation
+
+```bash
+composer require cslant/blog-core
+```
+
+##  Commit template
+
+If you want to use a commit template, you can use the following command in the root directory of this project:
 
-## commit template
 ```bash
 git config --local commit.template .github/commit_message.txt
+```
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.