Skip to content

Commit

Permalink
Update README and remove badges without cache invalidation
Browse files Browse the repository at this point in the history
  • Loading branch information
srstevenson committed Oct 19, 2024
1 parent 6106caf commit 3a4dce0
Showing 1 changed file with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down Expand Up @@ -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

0 comments on commit 3a4dce0

Please sign in to comment.