From a77149ed4381e2835c93b99c4fdd3723534320ad Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sun, 27 Aug 2023 20:22:31 -0400 Subject: [PATCH] Update the readme giving some background on the library's purpose and usage. Closes #4. --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 2b7445f..e0a3097 100644 --- a/README.rst +++ b/README.rst @@ -20,3 +20,11 @@ .. image:: https://img.shields.io/badge/skeleton-2023-informational :target: https://blog.jaraco.com/skeleton + +This package includes a collection of libraries and scripts used by `jaraco `_ and many of the `projects maintained by jaraco `_. + +It includes facilities for managing scores of repositories with SCM tools like Git, working with Read the Docs, determining release versions from pertinent changes, synchronizing related histories, automatically resolving known merge conflicts, and more. + +Many of the modules in this package are executable using ``runpy`` (e.g. ``python -m jaraco.develop.macos-build-python``). + +Although this package is built on assumptions about jaraco's workflow, these routines are provided here for shared use across those projects, transparency of operations, and for potential re-use. Contributions and feedback are welcome.