From 3a4dce07d72e3886206c7aab08afc0457f439199 Mon Sep 17 00:00:00 2001 From: Scott Stevenson Date: Sat, 19 Oct 2024 14:54:53 +0100 Subject: [PATCH] Update README and remove badges without cache invalidation --- README.md | 28 ++++++++-------------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 34e4428..7d96b3f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ # xdg-base-dirs -[![License](https://img.shields.io/github/license/srstevenson/xdg-base-dirs?label=License&color=blue)](https://github.com/srstevenson/xdg-base-dirs/blob/main/LICENSE) -[![GitHub release](https://img.shields.io/github/v/release/srstevenson/xdg-base-dirs?label=GitHub)](https://github.com/srstevenson/xdg-base-dirs) -[![PyPI version](https://img.shields.io/pypi/v/xdg-base-dirs?label=PyPI)](https://pypi.org/project/xdg-base-dirs/) -[![Python versions](https://img.shields.io/pypi/pyversions/xdg-base-dirs?label=Python)](https://pypi.org/project/xdg-base-dirs/) -[![CI status](https://github.com/srstevenson/xdg-base-dirs/workflows/CI/badge.svg)](https://github.com/srstevenson/xdg-base-dirs/actions) -[![Coverage](https://img.shields.io/codecov/c/gh/srstevenson/xdg-base-dirs?label=Coverage)](https://app.codecov.io/gh/srstevenson/xdg-base-dirs) - `xdg-base-dirs` is a Python module that provides functions to return paths to the directories defined by the [XDG Base Directory Specification][spec], to save you from duplicating the same snippet of logic in every Python utility you write that deals with user cache, configuration, or data files. It has no external dependencies. +`xdg-base-dirs` currently implements version 0.8 of the specification, released +on 8th May 2021. + > [!NOTE] > > `xdg-base-dirs` was previously named `xdg`, and was renamed due to an import @@ -22,20 +18,15 @@ dependencies. ## Installation -To install the latest release from [PyPI], use [pip]: +To install the latest release from [PyPI] with [pip], use: ```bash python3 -m pip install xdg-base-dirs ``` -The latest release of `xdg-base-dirs` currently implements version 0.8 of the -specification, released on 8th May 2021. - -In Python projects using [Poetry] or [PDM] for dependency management, add -`xdg-base-dirs` as a dependency with `poetry add xdg-base-dirs` or -`pdm add xdg-base-dirs`. Alternatively, since `xdg-base-dirs` is only a single -file you may prefer to just copy `src/xdg_base_dirs/__init__.py` from the source -distribution into your project. +Alternatively, since `xdg-base-dirs` is only a single file you may prefer to +just copy `src/xdg_base_dirs/__init__.py` from the source distribution into your +project. ## Usage @@ -70,16 +61,13 @@ not set, or contains a relative path rather than an absolute path. ## Copyright -Copyright © [Scott Stevenson]. +Copyright © Scott Stevenson. `xdg-base-dirs` is distributed under the terms of the [ISC license]. [isc license]: https://opensource.org/licenses/ISC [path]: https://docs.python.org/3/library/pathlib.html#pathlib.Path -[pdm]: https://pdm.fming.dev/ [pip]: https://pip.pypa.io/en/stable/ -[poetry]: https://python-poetry.org/ [pypi]: https://pypi.org/project/xdg-base-dirs/ -[scott stevenson]: https://scott.stevenson.io [spec]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html