From 48f12173767f7e22dabf22e9a3167c99653269ee Mon Sep 17 00:00:00 2001
From: Anatoly Nekhay <afenric@gmail.com>
Date: Sun, 7 Feb 2021 20:18:51 +0500
Subject: [PATCH] update README.md

---
 README.md | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 103 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index a179123..28991a6 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 ## Awesome Skeleton for modern development on PHP 7.4+ (incl. PHP 8)
 
+> Contains quality tested packages, thoughtful structure and everything you need to develop microservices.
+
 [![Build Status](https://circleci.com/gh/sunrise-php/awesome-skeleton.svg?style=shield)](https://circleci.com/gh/sunrise-php/awesome-skeleton)
 [![Code Coverage](https://scrutinizer-ci.com/g/sunrise-php/awesome-skeleton/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/awesome-skeleton/?branch=master)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunrise-php/awesome-skeleton/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunrise-php/awesome-skeleton/?branch=master)
@@ -15,9 +17,23 @@
 composer create-project 'sunrise/awesome-skeleton:^3.0' app
 ```
 
+## Cooking
+
+Set up your database connection:
+
+```bash
+cp .env.example .env && nano .env
+```
+
+Execute a migration:
+
+```bash
+php bin/app migrations:migrate --service 'master' --no-interaction
+```
+
 ## Run CLI
 
-> including: Doctrine DBAL, Doctrine ORM, Doctrine Migrations.
+> incl.: Doctrine DBAL, Doctrine ORM, Doctrine Migrations.
 
 ```bash
 php bin/app
@@ -35,10 +51,22 @@ composer serve
 
 > listen 0.0.0.0:3000
 
+Set up your server:
+
+```bash
+cp .rr.yml.example .rr.yml && nano .rr.yml
+```
+
+Run the server:
+
 ```bash
 rr -dv serve
 ```
 
+## Run via Swoole
+
+> Coming soon...
+
 ## Run tests
 
 ```bash
@@ -53,9 +81,81 @@ composer bench
 
 ---
 
+## Run routes through cURL
+
+> you may need to change the server address...
+
+#### Home (index)
+
+```bash
+curl -X 'GET' 'http://127.0.0.1:3000/'
+```
+
+#### OpenAPI document
+
+```bash
+curl -X 'GET' 'http://127.0.0.1:3000/openapi'
+```
+
+#### Create an entry (example bundle)
+
+```bash
+curl -X 'POST' -H 'Content-Type: application/json' -d '{"name": "foo", "slug": "foo"}' 'http://127.0.0.1:3000/api/v1/entry'
+```
+
+#### Update an existing entry (example bundle)
+
+> you need to set an existing ID.
+
+```bash
+curl -X 'PATCH' -H 'Content-Type: application/json' -d '{"name": "foo", "slug": "foo"}' 'http://127.0.0.1:3000/api/v1/entry/b06fd41d-d131-4bb9-a472-eb583369437c'
+```
+
+#### Delete an existing entry (example bundle)
+
+> you need to set an existing ID.
+
+```bash
+curl -X 'DELETE' 'http://127.0.0.1:3000/api/v1/entry/b06fd41d-d131-4bb9-a472-eb583369437c'
+```
+
+#### Read an existing entry (example bundle)
+
+> you need to set an existing ID.
+
+```bash
+curl -X 'GET' 'http://127.0.0.1:3000/api/v1/entry/b06fd41d-d131-4bb9-a472-eb583369437c'
+```
+
+#### List of entries (example bundle)
+
+```bash
+curl -X 'GET' 'http://127.0.0.1:3000/api/v1/entry'
+```
+
+---
+
 ## Useful commands
 
-#### Generate Systemd unit for RoadRunner 
+#### Deploy
+
+```bash
+bash bin/deploy
+```
+
+#### Down
+
+```bash
+bash bin/down 'Reason...'
+```
+
+#### Up
+
+```bash
+bash bin/up
+```
+
+#### Generate Systemd unit for RoadRunner
 
 ```bash
 php bin/app app:roadrunner:generate-systemd-unit > app.service
@@ -64,7 +164,7 @@ php bin/app app:roadrunner:generate-systemd-unit > app.service
 #### Generate OpenApi document
 
 ```bash
-php bin/app app:openapi:generate-documentation --pretty > openapi.json
+php bin/app app:openapi:generate-document > openapi.json
 ```
 
 ---