-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2768 from l0gicgate/4.x-UpdateReadme
Update README
- Loading branch information
Showing
1 changed file
with
45 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,18 +12,18 @@ Slim is a PHP micro-framework that helps you quickly write simple yet powerful w | |
It's recommended that you use [Composer](https://getcomposer.org/) to install Slim. | ||
|
||
```bash | ||
$ composer require slim/slim:4.0.0-beta | ||
$ composer require slim/slim:4.0.0 | ||
``` | ||
|
||
This will install Slim and all required dependencies. Slim requires PHP 7.1 or newer. | ||
|
||
## Choose a PSR-7 Implementation & ServerRequest Creator | ||
|
||
Before you can get up and running with Slim you will need to choose a PSR-7 implementation that best fits your application. A few notable ones: | ||
- [Slim-Psr7](https://github.com/slimphp/Slim-Psr7) - This is the Slim Framework projects PSR-7 implementation. | ||
- [Nyholm/psr7](https://github.com/Nyholm/psr7) & [Nyholm/psr7-server](https://github.com/Nyholm/psr7-server) - This is the fastest, strictest and most lightweight implementation at the moment. | ||
- [Guzzle/psr7](https://github.com/guzzle/psr7) & [http-interop/http-factory-guzzle](https://github.com/http-interop/http-factory-guzzle) - This is the implementation used by the Guzzle Client. It is not as strict but adds some nice functionality for Streams and file handling. It is the second fastest implementation but is a bit bulkier. | ||
- [zend-diactoros](https://github.com/zendframework/zend-diactoros) - This is the Zend implementation. It is the slowest implementation of the four. | ||
- [Slim-Psr7](https://github.com/slimphp/Slim-Psr7) - This is the Slim Framework PSR-7 implementation | ||
- [Nyholm/psr7](https://github.com/Nyholm/psr7) & [Nyholm/psr7-server](https://github.com/Nyholm/psr7-server) - This is the fastest, strictest and most lightweight implementation available | ||
- [Guzzle/psr7](https://github.com/guzzle/psr7) & [http-interop/http-factory-guzzle](https://github.com/http-interop/http-factory-guzzle) - This is the implementation used by the Guzzle Client, featuring extra functionality for stream and file handling | ||
- [zend-diactoros](https://github.com/zendframework/zend-diactoros) - This is the Zend PSR-7 implementation | ||
|
||
|
||
## Slim-Http Decorators | ||
|
@@ -47,7 +47,7 @@ ServerRequestCreatorFactory::setSlimHttpDecoratorsAutomaticDetection(false); | |
|
||
$app = AppFactory::create(); | ||
|
||
... | ||
// ... | ||
``` | ||
|
||
## Hello World using AppFactory with PSR-7 auto-detection | ||
|
@@ -62,17 +62,14 @@ In order for auto-detection to work and enable you to use `AppFactory::create()` | |
use Psr\Http\Message\ResponseInterface as Response; | ||
use Psr\Http\Message\ServerRequestInterface as Request; | ||
use Slim\Factory\AppFactory; | ||
use Slim\Middleware\ErrorMiddleware; | ||
|
||
require __DIR__ . '/../vendor/autoload.php'; | ||
|
||
// Instantiate App | ||
$app = AppFactory::create(); | ||
|
||
// Add error middleware | ||
$responseFactory = $app->getResponseFactory(); | ||
$errorMiddleware = new ErrorMiddleware($app->getCallableResolver(), $responseFactory, true, true, true); | ||
$app->add($errorMiddleware); | ||
$app->addErrorMiddleware(true, true, true); | ||
|
||
// Add route | ||
$app->get('/hello/{name}', function (Request $request, Response $response, $args) { | ||
|
@@ -91,7 +88,7 @@ $ php -S localhost:8000 | |
|
||
Going to http://localhost:8000/hello/world will now display "Hello, world". | ||
|
||
For more information on how to configure your web server, see the [Documentation](https://www.slimframework.com/docs/start/web-servers.html). | ||
For more information on how to configure your web server, see the [Documentation](https://www.slimframework.com/docs/v4/start/web-servers.html). | ||
|
||
## Tests | ||
To execute the test suite, you'll need to install all development dependencies. | ||
|
@@ -111,23 +108,51 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details. | |
Learn more at these links: | ||
|
||
- [Website](https://www.slimframework.com) | ||
- [Documentation](https://www.slimframework.com/docs/start/installation.html) | ||
- [Support Forum](http://discourse.slimframework.com) | ||
- [Documentation](https://www.slimframework.com/docs/v4/start/installation.html) | ||
- [Slack](https://slimphp.slack.com) | ||
- [Support Forum](https://discourse.slimframework.com) | ||
- [Twitter](https://twitter.com/slimphp) | ||
- [Resources](https://github.com/xssc/awesome-slim) | ||
|
||
## Security | ||
|
||
If you discover security related issues, please email [email protected] instead of using the issue tracker. | ||
|
||
## Credits | ||
## Professional support | ||
|
||
- [Josh Lockhart](https://github.com/codeguy) | ||
- [Andrew Smith](https://github.com/silentworks) | ||
- [Rob Allen](https://github.com/akrabat) | ||
- [Pierre Bérubé](https://github.com/l0gicgate) | ||
- [Gabriel Manricks](https://github.com/gmanricks) | ||
- [All Contributors](../../contributors) | ||
Slim is part of [Tidelift](https://tidelift.com/subscription/pkg/packagist-slim-slim?utm_source=packagist-slim-slim&utm_medium=referral&utm_campaign=readme) which gives software development teams a single source for purchasing and maintaining their software, with professional grade assurances from the experts who know it best, while seamlessly integrating with existing tools. | ||
|
||
## Contributors | ||
|
||
### Code Contributors | ||
|
||
This project exists thanks to all the people who contribute. [Contribute](CONTRIBUTING.md). | ||
<a href="https://github.com/slimphp/Slim/graphs/contributors"> | ||
<img src="https://opencollective.com/slimphp/contributors.svg?width=890&button=false" /> | ||
</a> | ||
|
||
### Financial Contributors | ||
|
||
Become a financial contributor and help us sustain our community. [Contribute](https://opencollective.com/slimphp/contribute) | ||
|
||
#### Individuals | ||
|
||
<a href="https://opencollective.com/slimphp"><img src="https://opencollective.com/slimphp/individuals.svg?width=890"></a> | ||
|
||
#### Organizations | ||
|
||
Support this project with your organization. Your logo will show up here with a link to your website. [Contribute](https://opencollective.com/slimphp/contribute) | ||
|
||
<a href="https://opencollective.com/slimphp/organization/0/website"><img src="https://opencollective.com/slimphp/organization/0/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/1/website"><img src="https://opencollective.com/slimphp/organization/1/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/2/website"><img src="https://opencollective.com/slimphp/organization/2/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/3/website"><img src="https://opencollective.com/slimphp/organization/3/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/4/website"><img src="https://opencollective.com/slimphp/organization/4/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/5/website"><img src="https://opencollective.com/slimphp/organization/5/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/6/website"><img src="https://opencollective.com/slimphp/organization/6/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/7/website"><img src="https://opencollective.com/slimphp/organization/7/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/8/website"><img src="https://opencollective.com/slimphp/organization/8/avatar.svg"></a> | ||
<a href="https://opencollective.com/slimphp/organization/9/website"><img src="https://opencollective.com/slimphp/organization/9/avatar.svg"></a> | ||
|
||
## License | ||
|
||
|