From c0e32f7472cb9ac0671a373a45d8044bcc6c3069 Mon Sep 17 00:00:00 2001 From: Zev Averbach Date: Fri, 8 Apr 2022 11:55:29 +0200 Subject: [PATCH] small docs update --- README.md | 13 +++++++------ setup.cfg | 9 +++++---- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6e32af9..70b6530 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@ This is a wrapper of [the roly-poly, not 100% ergonomic Freshbooks web API](http There are "band-aids" here to work around some of the API's shortcomings. +# Install + +``` +pip install avt-fresh +``` +See `Initializing` for additional setup. + # The Goodies ## Invoices @@ -45,12 +52,6 @@ Once more the `get...` functions return `NamedTuple` instances with some helpful Then, `update_contacts`, `delete_contact`, `add_contacts`, `get_freshbooks_client_from_client_id`, `get_freshbooks_client_from_email`, and `get_freshbooks_client_from_org_name`. -# Install - -``` -pip install avt-fresh -``` - # Prerequisites/Configuration Make yourself a nice little `.env` file in your home directory or wherever you're going to be calling this library's code. It needs to contain: diff --git a/setup.cfg b/setup.cfg index 8a2461a..a7b5b4f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,7 @@ [metadata] -description-file=README.md -license_files=LICENSE.txt -long_description=file: README.md -long_description_content_type=text/markdown +description = A nice, ergonomic wrapper of the Freshbooks API. +description-file = README.md +license_files = LICENSE.txt +long_description = file: README.md +long_description_content_type = text/markdown