From 4bed03977195a2a768ed8f9282614ff64849a1a9 Mon Sep 17 00:00:00 2001
From: Alexey Mezenin <alexeymezenin@gmail.com>
Date: Tue, 2 Nov 2021 06:29:55 +0200
Subject: [PATCH] Updated Readme

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index acc7b4c..7c2e6ef 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
-This Laravel app is part of the [RealWorld](https://github.com/gothinkster/realworld) project.
+###Laravel implementation of RealWorld app
+
+This Laravel app is part of the [RealWorld](https://github.com/gothinkster/realworld) project and implementation of the [Laravel best practices](https://github.com/alexeymezenin/laravel-best-practices).
 
 See how the exact same Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](https://gothinkster.github.io/realworld/docs/specs/backend-specs/introduction)**
+
+### How to run the API
+
+Clone the repo, enter the project folder and run these commands to install the app
+
+```
+ composer install
+ cp .env.example .env
+```
+
+Run the web server
+
+```
+php artisan serve
+```
+
+That's it. Now you can use the api, i.e.
+
+```
+http://127.0.0.1:8000/api/articles
+```
--
libgit2 0.24.0