From 84ac13857008859c033e075fcab73a37a8e8b6fe Mon Sep 17 00:00:00 2001 From: Milan Sulc Date: Thu, 4 Jun 2026 12:48:30 +0000 Subject: [PATCH 1/3] Docs: move documentation to README --- .docs/README.md | 29 ----------------------------- README.md | 28 +++++++++++++++++++++++++++- 2 files changed, 27 insertions(+), 30 deletions(-) delete mode 100644 .docs/README.md diff --git a/.docs/README.md b/.docs/README.md deleted file mode 100644 index 137ae68..0000000 --- a/.docs/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Apitte - -An opinionated and enjoyable API framework based on Nette Framework. Supporting content negotiation, debugging, middlewares, attributes and loving openapi/swagger. - -Need to start with Apitte -- [Setup](index.md) -- [Endpoints](endpoints.md) -- [Mapping](mapping.md) - -Plugins -- [Console](console.md) -- [Debug](debug.md) -- [Middlewares](middlewares.md) -- [Negotiation](negotiation.md) -- [OpenApi](openapi.md) -- [Presenter](presenter.md) - -This knowledge could make your life easier -- [Architecture](architecture.md) -- [Decorators](decorators.md) -- [Dispatcher](dispatcher.md) -- [Errors](errors.md) -- [Request and response](request-and-response.md) -- [Router](router.md) -- [Schema](schema.md) - -Examples -- https://github.com/contributte/apitte-skeleton (skeleton project) -- https://contributte.org/examples.html (more examples) diff --git a/README.md b/README.md index 1792fda..a015cb0 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,33 @@ composer require contributte/apitte ## Documentation -For details on how to use this package, check out our [documentation](.docs). +An opinionated and enjoyable API framework based on Nette Framework. Supporting content negotiation, debugging, middlewares, attributes and loving openapi/swagger. + +Need to start with Apitte +- [Setup](.docs/index.md) +- [Endpoints](.docs/endpoints.md) +- [Mapping](.docs/mapping.md) + +Plugins +- [Console](.docs/console.md) +- [Debug](.docs/debug.md) +- [Middlewares](.docs/middlewares.md) +- [Negotiation](.docs/negotiation.md) +- [OpenApi](.docs/openapi.md) +- [Presenter](.docs/presenter.md) + +This knowledge could make your life easier +- [Architecture](.docs/architecture.md) +- [Decorators](.docs/decorators.md) +- [Dispatcher](.docs/dispatcher.md) +- [Errors](.docs/errors.md) +- [Request and response](.docs/request-and-response.md) +- [Router](.docs/router.md) +- [Schema](.docs/schema.md) + +Examples +- https://github.com/contributte/apitte-skeleton (skeleton project) +- https://contributte.org/examples.html (more examples) ## Version From aa77d70d37215396b22065d4cfcff20dd7dddc6f Mon Sep 17 00:00:00 2001 From: Milan Sulc Date: Thu, 4 Jun 2026 13:23:44 +0000 Subject: [PATCH 2/3] Docs: adjust README intro order --- README.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a015cb0..a17b982 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,15 @@ Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

+An opinionated and enjoyable API framework based on Nette Framework. Supporting content negotiation, debugging, middlewares, attributes and loving openapi/swagger. + +## Version + +| State | Version | Branch | Nette | PHP | +|-------------|---------|----------|------|---------| +| dev | `^0.15` | `master` | 4.0+ | `>=8.2` | +| stable | `^0.14` | `master` | 4.0+ | `>=8.2` | + ## Usage To install the latest version of `contributte/apitte` use [Composer](https://getcomposer.org). @@ -26,10 +35,6 @@ To install the latest version of `contributte/apitte` use [Composer](https://get composer require contributte/apitte ``` -## Documentation - -An opinionated and enjoyable API framework based on Nette Framework. Supporting content negotiation, debugging, middlewares, attributes and loving openapi/swagger. - Need to start with Apitte - [Setup](.docs/index.md) - [Endpoints](.docs/endpoints.md) @@ -56,13 +61,6 @@ Examples - https://github.com/contributte/apitte-skeleton (skeleton project) - https://contributte.org/examples.html (more examples) -## Version - -| State | Version | Branch | Nette | PHP | -|-------------|---------|----------|------|---------| -| dev | `^0.15` | `master` | 4.0+ | `>=8.2` | -| stable | `^0.14` | `master` | 4.0+ | `>=8.2` | - ## Development See [how to contribute](https://contributte.org/contributing.html) to this package. From 3c0bdfaccd8449110e8ae14565239605059cf409 Mon Sep 17 00:00:00 2001 From: Milan Sulc Date: Thu, 4 Jun 2026 14:07:55 +0000 Subject: [PATCH 3/3] Docs: clean up README structure --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a17b982..a05754b 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ -

+

Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte @@ -20,7 +20,7 @@ Website 🚀 contributte.org | Contact An opinionated and enjoyable API framework based on Nette Framework. Supporting content negotiation, debugging, middlewares, attributes and loving openapi/swagger. -## Version +## Versions | State | Version | Branch | Nette | PHP | |-------------|---------|----------|------|---------| @@ -35,12 +35,12 @@ To install the latest version of `contributte/apitte` use [Composer](https://get composer require contributte/apitte ``` -Need to start with Apitte +**Getting started:** - [Setup](.docs/index.md) - [Endpoints](.docs/endpoints.md) - [Mapping](.docs/mapping.md) -Plugins +**Plugins:** - [Console](.docs/console.md) - [Debug](.docs/debug.md) - [Middlewares](.docs/middlewares.md) @@ -48,7 +48,7 @@ Plugins - [OpenApi](.docs/openapi.md) - [Presenter](.docs/presenter.md) -This knowledge could make your life easier +**Guides:** - [Architecture](.docs/architecture.md) - [Decorators](.docs/decorators.md) - [Dispatcher](.docs/dispatcher.md) @@ -57,7 +57,7 @@ This knowledge could make your life easier - [Router](.docs/router.md) - [Schema](.docs/schema.md) -Examples +**Examples:** - https://github.com/contributte/apitte-skeleton (skeleton project) - https://contributte.org/examples.html (more examples) @@ -65,7 +65,7 @@ Examples See [how to contribute](https://contributte.org/contributing.html) to this package. -This package is currently maintaining by these authors. +This package is currently maintained by these authors.