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..a05754b 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,21 @@ -

+

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. + +## Versions + +| 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,22 +35,37 @@ To install the latest version of `contributte/apitte` use [Composer](https://get composer require contributte/apitte ``` -## Documentation +**Getting started:** +- [Setup](.docs/index.md) +- [Endpoints](.docs/endpoints.md) +- [Mapping](.docs/mapping.md) -For details on how to use this package, check out our [documentation](.docs). +**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) -## Version +**Guides:** +- [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) -| State | Version | Branch | Nette | PHP | -|-------------|---------|----------|------|---------| -| dev | `^0.15` | `master` | 4.0+ | `>=8.2` | -| stable | `^0.14` | `master` | 4.0+ | `>=8.2` | +**Examples:** +- https://github.com/contributte/apitte-skeleton (skeleton project) +- https://contributte.org/examples.html (more examples) ## Development 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.