Skip to content

Commit

Permalink
Update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtmckee committed Dec 10, 2023
1 parent 1d89154 commit 7da33c6
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
feedparser - Parse Atom and RSS feeds in Python.
..
This file is part of feedparser.
Copyright 2010-2023 Kurt McKee <contactme@kurtmckee.org>
Copyright 2002-2008 Mark Pilgrim
Released under the BSD 2-clause license.
| Copyright 2010-2023 Kurt McKee <contactme@kurtmckee.org>
| Copyright 2002-2008 Mark Pilgrim

feedparser is open source. See the LICENSE file for more information.
feedparser
##########

Parse Atom and RSS feeds in Python.

----


Installation
============

feedparser can be installed by running pip:

.. code-block:: shell
.. code-block:: console
$ pip install feedparser
Expand All @@ -30,7 +37,7 @@ To build the documentation you'll need the Sphinx package, which is available at

You can then build HTML pages using a command similar to:

.. code-block:: shell
.. code-block:: console
$ sphinx-build -b html docs/ fpdocs
Expand All @@ -42,7 +49,7 @@ Testing

Feedparser has an extensive test suite, powered by tox. To run it, type this:

.. code-block:: shell
.. code-block:: console
$ python -m venv venv
$ source venv/bin/activate # or "venv\bin\activate.ps1" on Windows
Expand Down

0 comments on commit 7da33c6

Please sign in to comment.