diff --git a/README.md b/README.md index d4e551b..d2e4064 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,29 @@ Or clone the GitHub repository directly. `git clone git@github.com:KatyBrown/plot_phylo.git` +# Quick Start +For detailed usage instructions, visit our [ReadTheDocs page](https://plot-phylo.readthedocs.io/en/latest/index.html). + +To draw a phylogeny under the default settings onto a blank figure. + +``` +import matplotlib.pyplot as plt +import plot_phylo + +# Create an empty plot, 8in (width) by 10in (height) - matplotlib +f = plt.figure(figsize=(8, 10)) + +# Add an axis - matplotlib +ax = plt.subplot() + +# Plot the tree on this axis, using the default settings - plot_phylo +results = plot_phylo.plot_phylo("examples/primates.nw", ax) + +# Save the tree - matplotlib +plt.savefig("examples/basic_plot.png", bbox_inches='tight') +``` + + # Cite If you use this repository in your work, please cite: