Commit 433dacfe authored by Anton Smirnov's avatar Anton Smirnov
Browse files

Add compatibility to docs, update readme

parent d08b60b7

README.md

+10 −2
Original line number Diff line number Diff line
@@ -13,12 +13,20 @@ This is a pure PHP library that allows you to encode and decode Bencode data. 
Installation

------------



Run ``composer require 'sandfoxme/bencode:^1.3'``.

```

composer require 'sandfoxme/bencode:^1.4'

```



or opt in to a newer version:



```

composer require 'sandfoxme/bencode:^1.4 || ^2.4'

```



Documentation

-------------



Read full documentation here: <https://sandfox.dev/php/bencode.html>

Read full documentation here: <https://bencode.readthedocs.io/en/1.x/>



## Support

docs/index.rst

+9 −1
Original line number Diff line number Diff line
@@ -13,7 +13,15 @@ This is a pure PHP library that allows you to encode and decode Bencode data. 
Installation

============



Run ``composer require 'sandfoxme/bencode:^1.4'``.

.. code-block:: bash



    composer require 'sandfoxme/bencode:^1.4'



bencode 1.4+ is future compatible with bencode 2.4+ so you can optionally allow later version:



.. code-block:: bash



    composer require 'sandfoxme/bencode:^1.4 || ^2.4'



Encoding

========