Skip to content

Commit cf7289a

Browse files
MarcinOrlowskiMarcinOrlowski
authored
Merge pull request #213 from MarcinOrlowski/dev
Updated project logo
2 parents a4428b0 + 2130d58 commit cf7289a

19 files changed

+210
-109
lines changed

‎.codecov.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
##################################################################################
2+
#
3+
# Laravel API Response Builder CodeCov.io config file
4+
#
5+
# @package MarcinOrlowski\ResponseBuilder
6+
#
7+
# @author Marcin Orlowski <mail (#) marcinOrlowski (.) com>
8+
# @copyright 2016-2021 Marcin Orlowski
9+
# @license http://www.opensource.org/licenses/mit-license.php MIT
10+
# @link https://github.com/MarcinOrlowski/laravel-api-response-builder
11+
#
12+
##################################################################################
13+
14+
comment: false

‎.config/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](../docs/img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# REST API Response Builder for Laravel #
44

‎README.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](docs/img/logo.png)
1+
![REST API Response Builder for Laravel](artwork/laravel-api-response-builder-logo.svg)
22

33
# REST API Response Builder for Laravel #
44

@@ -39,17 +39,19 @@ Development branch:
3939
## Benefits ##
4040

4141
`ResponseBuilder` is written for REST API developers by REST API developer and is based on long-lasting experience on both
42-
"sides" of API. It's lightweight, extensively tested, simple to use yet flexible and powerful, with support for on-the-fly
43-
data conversion, localization, automatic message building, chained APIs and (hopefully) exhaustive documentation.
44-
But that's not all! The JSON structure produced by `ResponseBuilder` is designed with **users of your API** in mind,
45-
to make dealing with your API a breeze. Simple JSON response, with well-defined and predictable structure, easy to
46-
consume without any hassle or trickery.
47-
48-
You are even covered in a case of emergency, as provided Exception Handler helper, ensures your API keeps talking JSON (and
49-
not HTML) to its clients even in case of unexpected.
50-
51-
Did I mention, you would also get testing traits that automatically unit test your whole `ResponseBuilder` related code
52-
and configuration with just a few lines of code?
42+
"sides" of API. It's lightweight, with **no** dependencies, extensively tested and simple to use yet flexible and powerful,
43+
with support for [on-the-fly data conversion](docs/conversion.md), [localization support](docs/docs.md#messages-and-localization),
44+
automatic message building, [chained APIs](docs/docs.md#code-ranges) and (hopefully) [exhaustive documentation](docs/README.md).
45+
But that's not all! The JSON structure produced by `ResponseBuilder` is designed with **users of your API** in mind, so its
46+
structure is predictible and [well-defined](docs/docs.md#response-structure) which makes dealing with your API using
47+
`ResponseBuilder` library a breeze. Simple JSON response, with well-defined and predictable structure, easy to consume
48+
without any hassle or trickery. **Your** clients will love it. And will love **you** too :)
49+
50+
You are also covered in a case of emergency, as provided [ExceptionHandlerhelper](docs/exceptions.md), ensures your API keeps
51+
talking JSON (and NOT lame HTML) to its clients even in case of unexpected.
52+
53+
Did I mention, you would also get [testing traits](docs/testing.md) that automatically add PHPUnit based unit test to your
54+
whole `ResponseBuilder` related code and configuration with just a few lines of code **absolutely for free**?
5355

5456
## Features ##
5557

‎artwork/laravel-api-response-builder-logo.svg

+163-80
Loading

‎docs/CHANGES.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
2+
23

34
# REST API Response Builder for Laravel #
45

@@ -8,9 +9,10 @@
89
910
## CHANGE LOG ##
1011

11-
* v9.3.0 (2021-06-21)
12+
* v9.3.0 (2021-06-22)
1213
* Added `data_always_object` config option that, when enabled enforces response `data` node
1314
to always be JSON object (for `NULL` it will return empty object `{}`).
15+
* Updated project logo
1416
* Updated code style to match standard ruleset.
1517
* Improved code quality (fully pass on PHPStan's strict mode)
1618
* Fixed floats being rejected as direct primitive payload.

‎docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# REST API Response Builder for Laravel #
44

‎docs/compatibility.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Backward compatibility #
44

‎docs/config.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Configuration #
4-
4+
w
55
[« Documentation table of contents](README.md)
66

77
* [Configuration file](#configuration-file)

‎docs/conversion.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Data conversion #
44

‎docs/docs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
## Fundamentals ##
44

‎docs/examples.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Usage examples #
44

‎docs/exceptions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Exception Handling #
44

‎docs/img/logo.png

-113 KB
Binary file not shown.

‎docs/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Installataion #
44

‎docs/legacy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Legacy support #
44

‎docs/methods.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Exposed methods #
44

‎docs/requirements.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Table of contents #
44

‎docs/response.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Response object #
44

‎docs/testing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![REST API Response Builder for Laravel](img/logo.png)
1+
![REST API Response Builder for Laravel](../artwork/laravel-api-response-builder-logo.svg)
22

33
# Testing #
44

0 commit comments

Comments
 (0)