From 56163af1ecdc77ef89d13dcdb77f626da13bd1e1 Mon Sep 17 00:00:00 2001 From: Jordan Welsman Date: Wed, 15 Feb 2023 21:59:46 -0800 Subject: [PATCH] Docs: Gave the readme a facelift with new shields. --- README.md | 53 ++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 36 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 23eb95d..27ec51b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + ```ascii _ _ _ _ (_)_ _| |_(_) |___ @@ -7,17 +8,36 @@ |__/ ``` -![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/JordanWelsman/jutils) -![GitHub Release Date](https://img.shields.io/github/release-date/JordanWelsman/jutils) -![GitHub repo size](https://img.shields.io/github/repo-size/JordanWelsman/jutils) -![GitHub](https://img.shields.io/github/license/JordanWelsman/jutils) -![GitHub commit activity](https://img.shields.io/github/commit-activity/m/JordanWelsman/jutils) +------------------------------------------------------ -![PyPI](https://img.shields.io/pypi/v/jutl) -![PyPI - Python Version](https://img.shields.io/pypi/pyversions/jutl) -![PyPI - Wheel](https://img.shields.io/pypi/wheel/jutl) -![PyPI - Status](https://img.shields.io/pypi/status/jutl) -![PyPI - Downloads](https://img.shields.io/pypi/dm/jutl) +
+ +[![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/tags) +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/releases) +[![GitHub Release Date](https://img.shields.io/github/release-date/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/wiki/Version-History) +[![GitHub](https://img.shields.io/github/license/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/blob/main/LICENSE.md) +[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/commits/main) + +
+
+ +[![PyPI](https://img.shields.io/pypi/v/jutl?style=for-the-badge)](https://pypi.org/project/jutl) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/jutl?style=for-the-badge)](https://docs.python.org/3/whatsnew/3.11.html) +[![PyPI - Wheel](https://img.shields.io/pypi/wheel/jutl?style=for-the-badge)](https://pypi.org/project/jutl/#files) +[![PyPI - Status](https://img.shields.io/pypi/status/jutl?style=for-the-badge)](https://pypi.org/project/jutl/#data) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/jutl?style=for-the-badge)](https://pypi.org/project/jutl/#history) + +
+
+ +[![GitHub Repo stars](https://img.shields.io/github/stars/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/stargazers) +[![GitHub watchers](https://img.shields.io/github/watchers/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/watchers) +[![GitHub forks](https://img.shields.io/github/forks/JordanWelsman/jutils?style=for-the-badge)](https://github.com/JordanWelsman/jutils/network/members) +![Lines of code](https://img.shields.io/tokei/lines/github/JordanWelsman/jutils?style=for-the-badge) +![GitHub repo file count](https://img.shields.io/github/directory-file-count/JordanWelsman/jutils?style=for-the-badge) +![GitHub repo size](https://img.shields.io/github/repo-size/JordanWelsman/jutils?style=for-the-badge) + +
# Overview @@ -37,7 +57,7 @@ jutils is a simple `Python 3.10+` package which gives the user various tools. Th # Install & use 1. From terminal: `pip install jutl` -2. From python environment: `from jutl import ` where `` is: +2. From python environment: `from jutl import ` where `` is one from the following: - `averages` - `calculators` @@ -55,8 +75,8 @@ jutils is a simple `Python 3.10+` package which gives the user various tools. Th 1. Clone repository: `git clone https://github.com/JordanWelsman/jutils.git` 2. Build module for testing: `python3 setup.py bdist_wheel` -3. Install module locally: `pip install jutl -e . dev` -4. Run tests with PyTest: `pytest` +3. Install module locally: `pip install jutl -e .` +4. Run tests with PyTest: `pytest test/` where `` is one [from the above list](#install--use). # Objectives @@ -65,11 +85,12 @@ jutils is a simple `Python 3.10+` package which gives the user various tools. Th # Credits -`jutils` was created, developed, and is currently maintained by **Jordan Welsman**. +jutils was created, developed, and is currently maintained by **Jordan Welsman**. # Licence -`jutils` is developed and distributed under the `MIT` license. +jutils is developed and distributed under the `MIT` license. +> **Note** > See `LICENSE` for more details. # Links @@ -83,5 +104,3 @@ jutils is a simple `Python 3.10+` package which gives the user various tools. Th :briefcase: [Connect with me on Linkedin](https://linkedin.com/in/JordanWelsman/) :email: [Send me an email](mailto:jordan.welsman@outlook.com) - -:clapper: [Followed tutorial](https://www.youtube.com/watch?v=GIF3LaRqgXo/) by [Mark Smith (@judy2k)](https://twitter.com/judy2k/)