Skip to content

Commit

Permalink
Add licence. Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
davorg committed Mar 30, 2024
1 parent ec494aa commit 7a6f89d
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 4 deletions.
41 changes: 37 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
A Perl class that contains information about the various international Amazon
sites.

## Badges

Hopefully, these are all green.

([![CI](https://github.com/davorg-cpan/amazon-sites/actions/workflows/perltest.yml/badge.svg)](https://github.com/davorg-cpan/amazon-sites/actions/workflows/perltest.yml))
[![Coverage Status](https://coveralls.io/repos/github/davorg-cpan/amazon-sites/badge.svg?branch=main)](https://coveralls.io/github/davorg-cpan/amazon-sites?branch=main)
![Kwality](https://cpants.cpanauthors.org/release/DAVECROSS/Amazon-Sites.svg "Kwality")

## Example

use Amazon::Sites;
Expand All @@ -15,22 +23,47 @@ sites.
say $az_uk->tldr; # co.uk
say $az_uk->domain; # amazon.co.uk

For more documentation visit:

* https://metacpan.org/pod/Amazon::Sites

Or run `perldoc Amazon::Sites` once you have installed the module.

## Installation

Install like any other CPAN module.
The traditional way to install a Perl module is to download the latest zipped
tarball from CPAN (https://metacpan.org/dist/Amazon-Sites) and then run
through the following steps:

1. `unzip Amazon-Sites-X.X.X.tar.gz`
1. `tar xvf Amazon-Sites-X.X.X.tar`
1. `cd Amazon-Sites-X.X.X`
1. `perl Makefile.PL`
1. `make test`
1. `make install`

cpan Amazon::Sites
But there are programs that make this easier. For example, `cpan` comes as
part of the standard Perl installation:

Or
* `cpan Amazon::Sites`

cpanm Amazon::Sites
And many people use `cpanm` instead:

* `cpanm Amazon::Sites`

## Code

The code is maintained on GitHub.

* https://github.com/davorg-cpan/amazon-sites

## Questions, bugs and feature requests

All issues are tracked on GitHub:

* https://github.com/davorg-cpan/amazon-sites

## Author

* Dave Cross <dave@perlhacks.com>

18 changes: 18 additions & 0 deletions lib/Amazon/Site.pm
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,22 @@ If you've defined an associate code for this site, it will be included in the UR
}
}

=head1 COPYRIGHT
Copyright 2024, Dave Cross. All rights reserved.
=head1 LICENCE
This program is free software; you can redistribute it and/or modify it under
the terms of either:
=over 4
=item * the GNU General Public License as published by the Free Software
Foundation; either version 1, or (at your option) any later version, or
=item * the Artistic License version 2.0.
=back
1;
18 changes: 18 additions & 0 deletions lib/Amazon/Sites.pm
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,24 @@ codes and the values are the corresponding ASIN URLs.

1;

=head1 COPYRIGHT
Copyright 2024, Dave Cross. All rights reserved.
=head1 LICENCE
This program is free software; you can redistribute it and/or modify it under
the terms of either:
=over 4
=item * the GNU General Public License as published by the Free Software
Foundation; either version 1, or (at your option) any later version, or
=item * the Artistic License version 2.0.
=back
__DATA__
AE UAE ae AED 1
AU Australia com.au AUD 2
Expand Down

0 comments on commit 7a6f89d

Please sign in to comment.