From b2e082b7c6b5698b03159c452f3c2a1bce079d06 Mon Sep 17 00:00:00 2001 From: Mathew Guest Date: Tue, 19 Nov 2024 23:59:42 -0700 Subject: [PATCH] doc: more cleanup and description, linking license --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f874dc..83db7b2 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Principles: - Compatible with Linux, Windows, and Mac. Try to be compatible as possible otherwise. - Try to be compatible with alternate Python runtimes such as PyPy and older python environments. \*WIP -# PyPi Hosted Link +# Python Package Index (PyPi) - Installation Instruction This is the project page for PyPi: The Python Package Index for community third-party libraries @@ -33,6 +33,11 @@ pip list # list install packages in environment pip index version app_skellington # enumerate available distributions in pypi for package ``` +# Description + +This is a library. There is nothing to run by itself. It would be helpful to have a sample application that uses +it or something, but I don't have that ready at the moment. + # Application Configuration Site configurations are supported through ConfigObj. There is a config.spec @@ -77,7 +82,7 @@ or # Tests -Tests are a WIP. Recommendation is to run 'pytest' in the 'tests' directory. +Tests are a WIP and not fully built out yet. Recommendation is to run 'pytest' in the 'tests' directory. # Development @@ -157,6 +162,8 @@ You can view the current version number with the command: # License +See [license](LICENSE.txt) + MIT no attribution required - https://opensource.org/license/mit-0 * Allows commercial use.