Skip to content

Commit 7133e1f

Browse files
committed
Update README
1 parent 8a26163 commit 7133e1f

3 files changed

Lines changed: 16 additions & 14 deletions

File tree

.gitignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
vendor
22
composer.lock
3-
tests/Fixtures/*/cache
4-
tests/Fixtures/*/logs
53
.php_cs.cache

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22

33
> This bundle is currently in active development and not released yet.
44
5-
[![Build Status](https://travis-ci.org/tgalopin/flysystem-bundle.svg?branch=master)](https://travis-ci.org/tgalopin/flysystem-bundle)
5+
[![Build Status](https://travis-ci.org/thephpleague/flysystem-bundle.svg?branch=master)](https://travis-ci.org/thephpleague/flysystem-bundle)
66

77
[![SymfonyInsight](https://insight.symfony.com/projects/525fdfa3-d482-4218-b4b9-3c2efc305fac/big.svg)](https://insight.symfony.com/projects/525fdfa3-d482-4218-b4b9-3c2efc305fac)
88

99
This repository is a light Symfony bundle integrating the [Flysystem](https://flysystem.thephpleague.com)
10-
library into Symfony applications. It mainly aims at injecting Flysystem instance(s) efficiently into your
11-
Dependency Injection container.
10+
library into Symfony applications. It provides an efficient abstraction for the filesystem,
11+
for instance to use local files in development and a cloud storage in production or to use a memory
12+
filesystem in tests to increase their speed.
13+
14+
This bundle relies on **named aliases** (introduced in Symfony 4.2) in order to create and configure
15+
multiple filesystems and still follow the best practices of software architecture (SOLID principles).
1216

1317
## Installation
1418

@@ -17,26 +21,26 @@ flysystem-bundle requires PHP 7.1+ and Symfony 4.2+.
1721
You can install the bundle using Symfony Flex:
1822

1923
```
20-
composer require thephpleague/flysystem-bundle
24+
composer require league/flysystem-bundle
2125
```
2226

2327
## Documentation
2428

25-
1. [Getting started](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/1-getting-started.md)
26-
2. [Caching](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/2-caching.md)
27-
3. [Using the mount manager](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/3-using-mount-manager.md)
28-
4. [Configuration reference](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/4-configuration-reference.md)
29+
1. [Getting started](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/1-getting-started.md)
30+
2. [Caching](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/2-caching.md)
31+
3. [Using the mount manager](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/3-using-mount-manager.md)
32+
4. [Configuration reference](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/4-configuration-reference.md)
2933

3034
## Security Issues
3135

3236
If you discover a security vulnerability within the bundle, please follow
33-
[our disclosure procedure](https://github.com/tgalopin/flysystem-bundle/blob/master/docs/A-security-disclosure-procedure.md).
37+
[our disclosure procedure](https://github.com/thephpleague/flysystem-bundle/blob/master/docs/A-security-disclosure-procedure.md).
3438

3539
## Backward Compatibility promise
3640

3741
This library follows the same Backward Compatibility promise as the Symfony framework:
3842
[https://symfony.com/doc/current/contributing/code/bc.html](https://symfony.com/doc/current/contributing/code/bc.html)
3943

40-
> *Note*: many classes in this library are either marked `@final` or `@internal`.
44+
> *Note*: many classes in this bundle are either marked `@final` or `@internal`.
4145
> `@internal` classes are excluded from any Backward Compatiblity promise (you should not use them in your code)
4246
> whereas `@final` classes can be used but should not be extended (use composition instead).

composer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "thephpleague/flysystem-bundle",
3-
"description": "",
2+
"name": "league/flysystem-bundle",
3+
"description": "Symfony bundle integrating Flysystem into Symfony 4.2+ applications",
44
"type": "symfony-bundle",
55
"license": "MIT",
66
"authors": [

0 commit comments

Comments
 (0)