diff --git a/readme.md b/readme.md index f3df36a..fa2963f 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,17 @@ -![](https://cloud.githubusercontent.com/assets/829059/9216039/82be51cc-40f6-11e5-88f5-f0cbd07bcc39.png) +Note: This is an official and reasonably maintained fork of the popular https://github.com/dingo/api repository by one of the maintainers of that project. The reason it was forked is due to broken integrations with CI tools such as travis (which can only be fixed by owner), and in general to be able to better support the project and ensure non-breaking updates. + +In order to move to this repo, you merely need to update your composer file. All the namespaces and other aspects of the project are the same. Example instructions are below, to use the latest version: + +```bash +composer remove dingo/api +composer require api-ecosystem-for-laravel/dingo-api +``` -Note: This is an official fork of the https://github.com/dingo/api repository by one of the maintainers of that project. The reason it was worked is due to broken integrations with CI tools such as travis (which can only be fixed by owner), and in general to be able to better support the project. +Please note, we do not actively maintain the Lumen support of this project. If you are still using Lumen, we recommend you migrate to Laravel. + +--- + +![](https://cloud.githubusercontent.com/assets/829059/9216039/82be51cc-40f6-11e5-88f5-f0cbd07bcc39.png) The Dingo API package is meant to provide you, the developer, with a set of tools to help you easily and quickly build your own API. While the goal of this package is to remain as flexible as possible it still won't cover all situations and solve all problems.