Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 0 additions & 29 deletions .docs/README.md

This file was deleted.

48 changes: 37 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,62 @@
<a href="https://bit.ly/ctteg"><img src="https://badgen.net/badge/support/gitter/cyan"></a>
<a href="https://bit.ly/cttfo"><img src="https://badgen.net/badge/support/forum/yellow"></a>
<a href="https://contributte.org/partners.html"><img src="https://badgen.net/badge/become/a%20patron/F96854"></a>
<p>
</p>

<p align=center>
Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact 👨🏻‍💻 <a href="https://f3l1x.io">f3l1x.io</a> | Twitter 🐦 <a href="https://twitter.com/contributte">@contributte</a>
</p>

## Usage
An opinionated and enjoyable API framework based on Nette Framework. Supporting content negotiation, debugging, middlewares, attributes and OpenAPI/Swagger.

## Versions

| State | Version | Branch | Nette | PHP |
|-------------|---------|----------|------|---------|
| dev | `^0.15` | `master` | 4.0+ | `>=8.2` |
| stable | `^0.14` | `master` | 4.0+ | `>=8.2` |

## Installation

To install the latest version of `contributte/apitte` use [Composer](https://getcomposer.org).

```
```bash
composer require contributte/apitte
```

## Documentation
## Usage

For details on how to use this package, check out our [documentation](.docs).
**Getting started:**
- [Setup](.docs/index.md)
- [Endpoints](.docs/endpoints.md)
- [Mapping](.docs/mapping.md)

## Version
**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)

| State | Version | Branch | Nette | PHP |
|-------------|---------|----------|------|---------|
| dev | `^0.15` | `master` | 4.0+ | `>=8.2` |
| stable | `^0.14` | `master` | 4.0+ | `>=8.2` |
**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)

**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.

<a href="https://github.com/f3l1x">
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80">
Expand Down