From 702b1767bf632d5bae390ec1f855173d256bb52f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ingy=20d=C3=B6t=20Net?= Date: Thu, 19 Nov 2020 10:09:23 -0500 Subject: [PATCH] Updated the content of the README.md file --- README.md | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index dd179328..e9d71b2e 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,33 @@ -# PyYAML - The next generation YAML parser and emitter for Python. +PyYAML +====== -## Installing +A full-featured YAML processing framework for Python + +## Installation To install, type `python setup.py install`. -By default, the `setup.py` script checks whether LibYAML is installed -and if so, builds and installs LibYAML bindings. To skip the check -and force installation of LibYAML bindings, use the option `--with-libyaml`: -`python setup.py --with-libyaml install`. To disable the check and -skip building and installing LibYAML bindings, use `--without-libyaml`: -`python setup.py --without-libyaml install`. +By default, the `setup.py` script checks whether LibYAML is installed and if +so, builds and installs LibYAML bindings. +To skip the check and force installation of LibYAML bindings, use the option +`--with-libyaml`: `python setup.py --with-libyaml install`. +To disable the check and skip building and installing LibYAML bindings, use +`--without-libyaml`: `python setup.py --without-libyaml install`. -When LibYAML bindings are installed, you may use fast LibYAML-based -parser and emitter as follows: +When LibYAML bindings are installed, you may use fast LibYAML-based parser and +emitter as follows: >>> yaml.load(stream, Loader=yaml.CLoader) >>> yaml.dump(data, Dumper=yaml.CDumper) -If you don't trust the input stream, you should use: +If you don't trust the input YAML stream, you should use: >>> yaml.safe_load(stream) ## Testing -PyYAML includes a comprehensive test suite. To run the tests, -type `python setup.py test`. +PyYAML includes a comprehensive test suite. +To run the tests, type `python setup.py test`. ## Further Information @@ -33,9 +36,7 @@ type `python setup.py test`. - [PyYAML tutorial and reference](http://pyyaml.org/wiki/PyYAMLDocumentation). -- Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net or on - the [YAML-Core mailing list]( - http://lists.sourceforge.net/lists/listinfo/yaml-core). +- Discuss PyYAML with the maintainers in IRC #pyyaml irc.freenode.net. - Submit bug reports and feature requests to the [PyYAML bug tracker](https://github.com/yaml/pyyaml/issues). @@ -46,4 +47,5 @@ The PyYAML module was written by Kirill Simonov . It is currently maintained by the YAML and Python communities. PyYAML is released under the MIT license. + See the file LICENSE for more details.