Skip to content

Commit

Permalink
Readme and Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gtalarico committed May 2, 2018
1 parent dbcfd8f commit 61cf150
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 33 deletions.
13 changes: 10 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Pipes - Pipenv Environment Switcher
.. image:: https://img.shields.io/travis/gtalarico/pipenv_pipes.svg
:target: https://travis-ci.org/gtalarico/pipenv_pipes

.. image:: https://img.shields.io/codecov/gtalarico/pipenv_pipes.svg
:target: https://codecov.io/gh/gtalarico/pipenv-pipes

.. image:: https://readthedocs.org/projects/pipenv-pipes/badge/?version=latest
:target: https://pipenv-pipes.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Expand All @@ -33,23 +36,27 @@ Install
Usage
--------

* Show Available Pipenv Environments
Show Available Pipenv Environments

``pipes``

* Link Project Directory to Pipenv Environment (this adds a .project file to your environment folder)
Link Project Directory to Pipenv Environment (this adds a .project file to your environment folder)

``pipes envname --set /path/to/project``

* Go to directory and Activate Pipenv Enviroment Shell
Go to directory and Activate Pipenv Enviroment Shell

``pipes envname``

For more details check ``pipes --help``


Todo
-------

* Add cd-only flag (don't activate shell)
* Add tests + Contributing
* Setup Travis CI + Code Cov
* Add Documentation


Expand Down
28 changes: 0 additions & 28 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,3 @@ you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for Pipenv Pipes can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console
$ git clone git://github.com/gtalarico/pipenv_pipes
Or download the `tarball`_:

.. code-block:: console
$ curl -OL https://github.com/gtalarico/pipenv-pipes/tarball/master
Once you have a copy of the source, you can install it with:

.. code-block:: console
$ python setup.py install
.. _Github repo: https://github.com/gtalarico/pipenv-pipes
.. _tarball: https://github.com/gtalarico/pipenv-pipes/tarball/master
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
Usage
=====

To use Pipenv Pipes in a project::
For usage help run::

import pipenv_pipes
$ pipes --help

0 comments on commit 61cf150

Please sign in to comment.