summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIngy döt Net <ingy@ingy.net>2020-11-19 10:09:23 -0500
committerIngy döt Net <ingy@ingy.net>2021-09-02 09:23:19 -0700
commit702b1767bf632d5bae390ec1f855173d256bb52f (patch)
treeb60b0d8af07a2b4cfa16545ee6a58ace0f903873
parent99d27e78e87838e96c4a859d3fb87e9d36407811 (diff)
downloadpyyaml-git-702b1767bf632d5bae390ec1f855173d256bb52f.tar.gz
Updated the content of the README.md file
-rw-r--r--README.md34
1 files changed, 18 insertions, 16 deletions
diff --git a/README.md b/README.md
index dd17932..e9d71b2 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 <xi@resolvent.net>.
It is currently maintained by the YAML and Python communities.
PyYAML is released under the MIT license.
+
See the file LICENSE for more details.