From ddfa4d3cf8894c4ce95bd44e7d4e814d0b5e595a Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Sat, 6 Apr 2024 22:57:23 +0100 Subject: [PATCH] Checking in changes prior to tagging of version 0.02. Changelog diff is: diff --git a/Changes b/Changes index 96c94f1..0441b27 100644 --- a/Changes +++ b/Changes @@ -2,6 +2,11 @@ Revision history for Perl extension Sqids {{$NEXT}} +0.02 2024-04-06T21:57:16Z + + - Update to upstream repository details + - Fix POD formatting + 0.01 2024-04-06T10:42:51Z - initial version, working from reference spec --- Changes | 5 +++++ META.json | 10 +++++----- README.md | 6 +++--- lib/Sqids.pm | 30 +++++++++++++++--------------- 4 files changed, 28 insertions(+), 23 deletions(-) diff --git a/Changes b/Changes index 96c94f1..0441b27 100644 --- a/Changes +++ b/Changes @@ -2,6 +2,11 @@ Revision history for Perl extension Sqids {{$NEXT}} +0.02 2024-04-06T21:57:16Z + + - Update to upstream repository details + - Fix POD formatting + 0.01 2024-04-06T10:42:51Z - initial version, working from reference spec diff --git a/META.json b/META.json index e2d5e11..5f54f1d 100644 --- a/META.json +++ b/META.json @@ -57,16 +57,16 @@ "release_status" : "unstable", "resources" : { "bugtracker" : { - "web" : "https://github.com/dracos/sqids-perl/issues" + "web" : "https://github.com/sqids/sqids-perl/issues" }, - "homepage" : "https://github.com/dracos/sqids-perl", + "homepage" : "https://github.com/sqids/sqids-perl", "repository" : { "type" : "git", - "url" : "https://github.com/dracos/sqids-perl.git", - "web" : "https://github.com/dracos/sqids-perl" + "url" : "https://github.com/sqids/sqids-perl.git", + "web" : "https://github.com/sqids/sqids-perl" } }, - "version" : "0.01", + "version" : "0.02", "x_contributors" : [ "Ivan Akimov " ], diff --git a/README.md b/README.md index 0423df6..78d1309 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Actions Status](https://github.com/dracos/sqids-perl/actions/workflows/test.yml/badge.svg)](https://github.com/dracos/sqids-perl/actions) +[![Actions Status](https://github.com/sqids/sqids-perl/actions/workflows/test.yml/badge.svg)](https://github.com/sqids/sqids-perl/actions) # NAME Sqids - generate short unique identifiers from numbers @@ -22,8 +22,8 @@ Sqids - generate short unique identifiers from numbers # DESCRIPTION -[Sqids](https://sqids.org/perl) (\*pronounced "squids"\*) is a small -library that lets you \*\*generate unique IDs from numbers\*\*. It's good for link +[Sqids](https://sqids.org/perl) (_pronounced "squids"_) is a small +library that lets you **generate unique IDs from numbers**. It's good for link shortening, fast & URL-safe ID generation and decoding back into numbers for quicker database lookups. diff --git a/lib/Sqids.pm b/lib/Sqids.pm index b102c00..856124a 100644 --- a/lib/Sqids.pm +++ b/lib/Sqids.pm @@ -13,7 +13,7 @@ use Class::Tiny { blocklist => sub { Sqids::Constants::DEFAULT_BLOCKLIST }, }; -our $VERSION = "0.01"; +our $VERSION = "0.02"; sub BUILD { my ($self, $args) = @_; @@ -284,8 +284,8 @@ Sqids - generate short unique identifiers from numbers =head1 DESCRIPTION -L (*pronounced "squids"*) is a small -library that lets you **generate unique IDs from numbers**. It's good for link +L (I) is a small +library that lets you B. It's good for link shortening, fast & URL-safe ID generation and decoding back into numbers for quicker database lookups. @@ -293,19 +293,19 @@ Features: =over 4 -=item B - generate short IDs from one or several non-negative numbers +=item * B - generate short IDs from one or several non-negative numbers -=item B - easily decode IDs back into numbers +=item * B - easily decode IDs back into numbers -=item B - generate unique IDs by shuffling the alphabet once +=item * B - generate unique IDs by shuffling the alphabet once -=item B - provide minimum length to make IDs more uniform +=item * B - provide minimum length to make IDs more uniform -=item B - auto-generated IDs do not contain common profanity +=item * B - auto-generated IDs do not contain common profanity -=item B - Sequential input provides nonconsecutive IDs +=item * B - Sequential input provides nonconsecutive IDs -=item B - Support for L<40+ programming languages|https://sqids.org/> +=item * B - Support for L<40+ programming languages|https://sqids.org/> =back @@ -315,11 +315,11 @@ Good for: =over 4 -=item Generating IDs for public URLs (eg: link shortening) +=item * Generating IDs for public URLs (eg: link shortening) -=item Generating IDs for internal systems (eg: event tracking) +=item * Generating IDs for internal systems (eg: event tracking) -=item Decoding for quicker database lookups (eg: by primary keys) +=item * Decoding for quicker database lookups (eg: by primary keys) =back @@ -327,9 +327,9 @@ Not good for: =over 4 -=item Sensitive data (this is not an encryption library) +=item * Sensitive data (this is not an encryption library) -=item User IDs (can be decoded revealing user count) +=item * User IDs (can be decoded revealing user count) =back