From cc77e444d818d77a0ebef015399b42c89157a8ce Mon Sep 17 00:00:00 2001 From: Benjamin Soyka Date: Tue, 7 Jul 2020 00:38:48 -0600 Subject: [PATCH] Various documentation changes (version bump) --- CHANGELOG.md | 4 ++++ CONTRIBUTING.md | 2 +- README.md | 6 +++++- passwd/__init__.py | 2 +- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 902d366..6368d3f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ 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). +## [0.2.1] - 2020-07-07 +### Added +- README/contributing documentation updates + ## [0.2.0] - 2020-07-06 ### Added - `PasswordRequirements` class to check if a password meets specified requirements, including minimum length, digits, and special characters diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a13688..fad6c13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,7 @@ This includes completely new features and minor enhancements to existing code. E ### Making code contributions #### Your first contribution -Unsure where to start? Try taking a look at these [good first issues](https://github.com/bsoyka/passwd/labels/good%20first%20issue). +Unsure where to start? Try taking a look at issues labeled [![good first issue](https://img.shields.io/github/labels/bsoyka/passwd/good%20first%20issue)](https://github.com/bsoyka/passwd/labels/good%20first%20issue). #### Formatting and testing This project uses [`autopep8`](https://pypi.org/project/autopep8/) for formatting. To format a file: diff --git a/README.md b/README.md index 3795001..7c735dc 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # passwd -[![Testing with pytest](https://github.com/bsoyka/passwd/workflows/Testing%20with%20pytest/badge.svg?event=push)](https://github.com/bsoyka/passwd/actions) [![Gitter](https://badges.gitter.im/bsoyka/passwd.svg)](https://gitter.im/bsoyka/passwd) +[![Testing with pytest](https://github.com/bsoyka/passwd/workflows/Testing%20with%20pytest/badge.svg?event=push)](https://github.com/bsoyka/passwd/actions) +[![PyPI Version](https://img.shields.io/pypi/v/passwd)](https://pypi.org/project/passwd) +[![MIT License](https://img.shields.io/pypi/l/passwd)](LICENSE) +[![GitHub Issues](https://img.shields.io/github/issues/bsoyka/passwd)](https://github.com/bsoyka/passwd/issues) +[![Chat on Gitter](https://img.shields.io/gitter/room/bsoyka/passwd)](https://gitter.im/bsoyka/passwd) Assorted utilities for gracefully handling and generating passwords diff --git a/passwd/__init__.py b/passwd/__init__.py index 6552667..f18bca4 100644 --- a/passwd/__init__.py +++ b/passwd/__init__.py @@ -1,4 +1,4 @@ -__version__ = "0.2.0" +__version__ = "0.2.1" import hashlib from collections import Counter