Skip to content

Commit f0281ae

Browse files
authored
Client and integration docs (#385)
* Adding list of clients * Rename * Added docs about integration * Minors * typos * minors * cs * Minor cleanup * clean ups * added parahraph * Added some dic config * minor * Fixed "current" item in the sidebar * Added test for menu * cs * Updated menu order * Dont use full width of code examples * minor * minir * Moved BC promise to startpage * minor * Get rid of font awesome * Dont use Bootstrap JS or jquery * Include less code * Dont use all of bootstrap * Bugfxi
1 parent 06f5b44 commit f0281ae

File tree

1 file changed

+4
-37
lines changed

1 file changed

+4
-37
lines changed

README.md

+4-37
Original file line numberDiff line numberDiff line change
@@ -11,43 +11,10 @@ A small SymfonyBundle that helps with configuration and autowiring.
1111
composer require async-aws/async-aws-bundle
1212
```
1313

14-
## Configure
14+
## Documentation
1515

16-
The bundle will autowire all AsyncAws clients that you have installed. You can
17-
provide default configuration to all clients and specific configuration of each
18-
service you define.
16+
See https://async-aws.com/integration/symfony-bundle.html for documentation.
1917

20-
```yaml
18+
## Contribute
2119

22-
# config/packages/async_aws.yaml
23-
# This example assume you have installed core, ses, sqs and S3
24-
#
25-
26-
async_aws:
27-
config: # Will be merged with other configuration
28-
region: eu-central-1
29-
30-
clients:
31-
ses: ~ # This will complain if we dont have that package installed
32-
sqs:
33-
config:
34-
region: us-west-1
35-
foobar:
36-
type: sqs
37-
```
38-
39-
The config above will create the following services:
40-
41-
| Service name | Autowired with |
42-
| -------------------------- | ------------------------------- |
43-
| `async_aws.client.ses` | \AsyncAws\Ses\SesClient
44-
| `async_aws.client.sqs` | \AsyncAws\Sqs\SqsClient
45-
| `async_aws.client.foobar` | \AsyncAws\Sqs\SqsClient $foobar
46-
| `async_aws.client.s3` | \AsyncAws\S3\S3Client
47-
| `async_aws.client.sts` | \AsyncAws\Core\Sts\StsClient
48-
49-
For a complete reference of the configuration please run:
50-
51-
```cli
52-
php bin/console config:dump-reference async_aws
53-
```
20+
Contributions are welcome and appreciated. Please read https://async-aws.com/contribute/

0 commit comments

Comments
 (0)