README.md in captive-api-1.0.0 vs README.md in captive-api-1.1.0
- old
+ new
@@ -1,8 +1,12 @@
# Captive::Api
-Short description and motivation.
+[![Gem Version](https://img.shields.io/gem/v/captive-api.svg)](https://rubygems.org/gems/captive-api)
+
+
+Code commun des API de Captive
+
## Usage
How to use my plugin.
Implementation :
@@ -13,9 +17,16 @@
...
end
end
end
```
+
+The class `Captive::Api::ApplicationController` includes 2 concerns :
+
+| Nom du concern | Description |
+|:-----|:--------:|
+| [pagination](https://github.com/Captive-Studio/captive-api/blob/main/app/controllers/concerns/api/pagination_concern.rb) | Logique de pagination pour les index |
+| [render error](https://github.com/Captive-Studio/captive-api/blob/main/app/controllers/concerns/api/render_error_concern.rb) | Attrape certaines erreurs pour retourner une page d'erreur en json. Permet aussi d'utiliser les méthodes pour rendre des pages d'erreur json manuellement |
## Installation
Add this line to your application's Gemfile:
```ruby