diff --git a/README.rst b/README.rst index 3749972f..948c184f 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,19 @@ -Pipenv: a sacred marriage of Pipfile, Pip, & Virtualenv -======================================================= +Pipenv: sacred marriage of Pipfile, Pip, & Virtualenv +===================================================== Pipenv is an experimental project that aims to bring the best of all packaging worlds to the Python world. It harnesses `pipfile `_, pip, and virtualenv into one single toolchain. Features -------- -- Automatically generates a Pipfile, if one doesn't exist. +- Automatically generates a Pipfile, if one doesn't exist. +- Automatically generates a Pipfile.lock, if one doesn't exist. - Automatically creates a virtualenv in a standard location. -- Automatically adds packages to a Pipfile when they are installed. +- Automatically adds packages to a Pipfile when they are installed. - Automatically removes packages from a Pipfile when they are un-installed. -- It also automatically updates pip. +- Also automatically updates pip. + +The main commands are ``init``, which initializes the environment, ``install`` and ``uninstall``, and ``freeze``, which generates a Pipfile.lock. Usage -----