README: New file

2 files changed, 54 insertions, 0 deletions

diff --git a/MANIFEST b/MANIFEST
index cf8247f..6e79c34 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -1,6 +1,7 @@
 COPYING
 MANIFEST
 Makefile.PL
+README
 lib/Math/Decimal/FastPP.pm
 t/00_compile.t
 t/20_nj-st-75-2017.t
diff --git a/README b/README
new file mode 100644
index 0000000..3f0a8fa
--- /dev/null
+++ b/README
@@ -0,0 +1,53 @@
+=head1 Math::Decimal::FastPP
+
+Math::Decimal::FastPP provides a few common decimal arithmetic functions
+written in pure Perl.  The functions are of course slower than Perl's
+built-in binary floating-point arithmetic, but they're faster than
+L<Math::BigFloat> and other commonly used decimal arithmetic modules.
+
+This module is currently less complete than Perl's built-in arithmetic
+and other decimal arithmetic modules.  So far it only includes addition,
+multiplication, and rounding functions.
+
+Despite the similar name and purpose, this module is not compatible with
+L<Math::Decimal>.
+
+=head2 INSTALLATION
+
+To install this module, run the following commands:
+
+    perl Makefile.PL
+    make
+    make test
+    make install
+
+DOCUMENTATION
+
+Documentation for this module is embedded within it and can be formatted
+with perldoc:
+
+    perldoc lib/Math/Decimal/FastPP.pm
+
+After installing, you can refer to the module by name instead of by file
+path:
+
+    perldoc Math::Decimal::FastPP
+
+=head2 COPYRIGHT
+
+Copyright (C) 2017  Patrick McDermott
+
+=head2 LICENSE
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see L<http://www.gnu.org/licenses/>.