Update README to reference packagist and replace must also be fully lowercase
This commit is contained in:
parent
a7ff2db60e
commit
f12ed63bd8
19
README.md
19
README.md
|
@ -6,23 +6,12 @@ This is a Matrix client-server SDK for php 7.0+, mostly copied from [matrix-org/
|
||||||
This package is still a work in progress, and at the current time, not everything has been ported:
|
This package is still a work in progress, and at the current time, not everything has been ported:
|
||||||
- Missing E2E encryption, need php bindings for the OLM library
|
- Missing E2E encryption, need php bindings for the OLM library
|
||||||
- No live sync, because I'm not going to go into php multithreading
|
- No live sync, because I'm not going to go into php multithreading
|
||||||
- Unit tests for the client (soon)
|
- Unit tests for the client
|
||||||
|
|
||||||
<aside class="warning">
|
|
||||||
THIS HAS NOT YET BEEN FULLY TESTED
|
|
||||||
</aside>
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Stable release
|
```
|
||||||
|
composer require aryess/php-matrix-sdk
|
||||||
tba
|
|
||||||
|
|
||||||
### Developement version
|
|
||||||
```shell
|
|
||||||
git clone https://github.com/aryess/matrix-php-sdk.git
|
|
||||||
cd matrix-php-sdk
|
|
||||||
composer install
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
@ -96,4 +85,4 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
|
||||||
[link-downloads]: https://packagist.org/packages/Aryess/PhpMatrixSdk
|
[link-downloads]: https://packagist.org/packages/Aryess/PhpMatrixSdk
|
||||||
[link-author]: https://github.com/aryess
|
[link-author]: https://github.com/aryess
|
||||||
[link-contributors]: ../../contributors
|
[link-contributors]: ../../contributors
|
||||||
[python-pck]: https://github.com/matrix-org/matrix-python-sdk
|
[python-pck]: https://github.com/matrix-org/matrix-python-sdk
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"replace": {
|
"replace": {
|
||||||
"Aryess/PhpMatrixSdk": "self.version"
|
"aryess/phpmatrixsdk": "self.version"
|
||||||
},
|
},
|
||||||
"require": {
|
"require": {
|
||||||
"php": "~7.2",
|
"php": "~7.2",
|
||||||
|
|
Loading…
Reference in a new issue