Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
WinterPhoenix authored Jul 31, 2024
1 parent 0c804b2 commit eaa7f08
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
| |pypi| |license| |coverage| |master_build|
| |sonar_maintainability| |sonar_reliability| |sonar_security|
Pure python module for (de)serialization to and from VDF that works just like ``json``.

Tested and works on ``py2.7``, ``py3.3+``, ``pypy`` and ``pypy3``.
A fork of `ValvePython/vdf <https://github.com/ValvePython/vdf>`_, which has apparently been abandoned.

Supports Python ``3.3+``

VDF is Valve's KeyValue text file format

Expand All @@ -15,17 +14,17 @@ https://developer.valvesoftware.com/wiki/KeyValues
Install
-------

You can grab the latest release from https://pypi.org/project/vdf/ or via ``pip``

.. code:: bash
pip install vdf
**WARNING:** Only ValvePython's (out of date) version is on PyPI.

Install the current dev version from ``github``
Installing directly from ``github`` repository:

.. code:: bash
pip install git+https://github.com/ValvePython/vdf
# master
pip install "git+https://github.com/solsticegamestudios/vdf"
# specific version
pip install "git+https://github.com/solsticegamestudios/[email protected]"
Problems & solutions
Expand Down

0 comments on commit eaa7f08

Please sign in to comment.