From f5dc39752bca74d9cf9796a9c18ee4b6dcff043a Mon Sep 17 00:00:00 2001 From: jciskey Date: Sun, 7 May 2017 22:16:15 -0500 Subject: [PATCH] Add installation instructions and usage examples --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 82b468e..f24f53c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # pygraph A graph manipulation library in pure Python +Available on [PyPI](https://pypi.python.org/pypi/pygraph) + Pygraph aims to be an easy-to-use and functional graph library that doesn't sacrifice advanced capabilities or usability in the process. By implementing the library in pure Python, it can be installed without any dependencies aside from the Python core, enabling maximum ease of use. @@ -42,6 +44,16 @@ Planar Embedding | :x: Unsupported Fully-Dynamic Planarity Testing | :x: Unsupported +## Installation && Usage +Installing the module is as easy as `pip install pygraph` + +```python +>>> import pygraph +>>> g = pygraph.build_chvatal_graph() +>>> pygraph.is_planar(g) +False +``` + ## Running the Test Suite The entire test suite is written using the standard library unittest module, so you should be able to run it with whichever framework you most prefer. We recommend [nose](http://nose.readthedocs.io/).