Merge pull request #3 from paultcochrane/pr/readme-updates

Updates to README
geofffranks · Oct 22, 2015 · e730b05 · e730b05
2 parents 639857f + 9b2481d
commit e730b05
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 17 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# Test::MockModule - mock subroutines in a module
+
+See the LICENSE section in `lib/Test/MockModule.pm` for usage and
+distribution rights.
+
+## Installation
+
+Run these commands in the source directory:
+
+    perl Build.PL
+    ./Build
+    ./Build test
+    ./Build install
+
+Then delete the source directory tree since it's no longer needed.
+
+Alternatively, you can simply install the module via `cpanm`:
+
+    cpanm Test::MockModule
+
+## Documentation
+
+Run `perldoc Test::MockModule` to read the full documentation.