Skip to content

updated readme #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bidi47 wants to merge 1 commit into
base: 7.0
Choose a base branch
from
Open

updated readme #541

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

Dotkernel API is a production-ready REST API application built on the [Mezzio microframework](https://github.com/mezzio) and [Laminas](https://github.com/laminas) components, which implements standards like PSR-3, PSR-4, PSR-7, PSR-11 and PSR-15.

It ships assembled rather than as a starting point: OAuth2 authorisation, role-based access control, HAL responses with RFC 7807 error handling, admin and user management, mail, pagination, and a generated OpenAPI specification are wired together, tested, and maintained as a unit.
It ships assembled rather than as a starting point: OAuth2 authorization, role-based access control, HAL responses with RFC 7807 error handling, admin and user management, mail, pagination, and a generated OpenAPI specification are wired together, tested, and maintained as a unit.

Dotkernel API is an alternative for legacy Laminas API Tools (formerly Apigility) applications and is based on Enrico Zimuel's [Zend Expressive API - Skeleton example](https://github.com/ezimuel/zend-expressive-api).

> Live [demo](https://api.dotkernel.net/).

## Documentation

Documentation is available at: https://docs.dotkernel.org/api-documentation/
Check out the full documentation available at https://docs.dotkernel.org/api-documentation/.

## Version History

Expand Down Expand Up @@ -86,7 +86,7 @@ composer development-status

### Setup database

Use an existing empty one or create a new **MariaDB**/**MySQL** database.
Use an existing empty database or create a new **MariaDB**/**Postgres** one.

> Recommended collation: `utf8mb4_general_ci`.

Expand Down