diff --git a/CHANGELOG.md b/CHANGELOG.md index f4c0174..3c1b9b2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.0.1] + +### Added +- PyPI version and downloads badges to README +- Changelog section link in README +- Changelog and Discussions URLs to project metadata in pyproject.toml + +### Changed +- Improved package description in README and pyproject.toml - reordered text to prioritize main functionality description + + ## [1.0.0] ### Added @@ -26,5 +37,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Support for source code, markup, data formats, configuration files, and more - Python 3.8+ compatibility +[1.0.1]: https://github.com/ysskrishna/text-extensions/compare/v1.0.0...v1.0.1 [1.0.0]: https://github.com/ysskrishna/text-extensions/releases/tag/v1.0.0 diff --git a/README.md b/README.md index 0072d33..6720793 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,10 @@ [![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ysskrishna/text-extensions/blob/main/LICENSE) ![Tests](https://github.com/ysskrishna/text-extensions/actions/workflows/test.yml/badge.svg) +[![PyPI](https://img.shields.io/pypi/v/text-extensions)](https://pypi.org/project/text-extensions/) +[![PyPI Downloads](https://static.pepy.tech/personalized-badge/text-extensions?period=total&units=INTERNATIONAL_SYSTEM&left_color=GREY&right_color=BLUE&left_text=downloads)](https://pepy.tech/projects/text-extensions) -Python port of [text-extensions](https://github.com/sindresorhus/text-extensions) npm package. Check if a file or extension is text, and iterate over 300+ known text file types including source code, markup, data formats, and configuration files. +Check if a file or extension is text, and iterate over 300+ known text file types including source code, markup, data formats, and configuration files. Python port of [text-extensions](https://github.com/sindresorhus/text-extensions) npm package. ## Features @@ -84,6 +86,11 @@ The package includes support for hundreds of text file extensions, including: This package is a Python port of the [text-extensions](https://github.com/sindresorhus/text-extensions) npm package by [Sindre Sorhus](https://github.com/sindresorhus). + +## Changelog + +See [CHANGELOG.md](https://github.com/ysskrishna/text-extensions/blob/main/CHANGELOG.md) for a detailed list of changes and version history. + ## Contributing Contributions are welcome! Please read our [Contributing Guide](https://github.com/ysskrishna/text-extensions/blob/main/CONTRIBUTING.md) for details on our code of conduct, development setup, and the process for submitting pull requests. diff --git a/pyproject.toml b/pyproject.toml index 89a4644..f5336de 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "text-extensions" -version = "1.0.0" -description = "Python port of text-extensions npm package. Check if a file or extension is text, and iterate over 300+ known text file types including source code, markup, data formats, and configuration files." +version = "1.0.1" +description = "Check if a file or extension is text, and iterate over 300+ known text file types including source code, markup, data formats, and configuration files. Python port of text-extensions npm package." readme = "README.md" requires-python = ">=3.8" authors = [ @@ -38,7 +38,9 @@ keywords = [ "utilities", "utils", "ascii", - "source-code" + "source-code", + "mit license", + "ysskrishna" ] dependencies = [] @@ -51,6 +53,8 @@ dev = [ Homepage = "https://github.com/ysskrishna/text-extensions" Repository = "https://github.com/ysskrishna/text-extensions.git" Issues = "https://github.com/ysskrishna/text-extensions/issues" +Changelog = "https://github.com/ysskrishna/text-extensions/blob/main/CHANGELOG.md" +Discussions = "https://github.com/ysskrishna/text-extensions/discussions" [build-system] requires = ["hatchling"]