From d0aeea36ca8b5d8e835bbeed55c23c4a059f9ae7 Mon Sep 17 00:00:00 2001
From: Shlomi Fish <shlomif@shlomifish.org>
Date: Mon, 6 Feb 2017 22:05:38 +0200
Subject: [PATCH] Add the README.md file.

CPANTS and GitHub Kwalitee/quality and good measure. This is part of the
CPAN PRC.
---
 README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b3e3a97
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# ABOUT
+
+File::ShareDir - Locate per-dist and per-module shared files
+
+## SYNOPSIS
+
+```
+use File::ShareDir ':ALL';
+
+# Where are distribution-level shared data files kept
+$dir = dist_dir('File-ShareDir');
+
+# Where are module-level shared data files kept
+$dir = module_dir('File::ShareDir');
+
+# Find a specific file in our dist/module shared dir
+$file = dist_file(  'File-ShareDir',  'file/name.txt');
+$file = module_file('File::ShareDir', 'file/name.txt');
+
+# Like module_file, but search up the inheritance tree
+$file = class_file( 'Foo::Bar', 'file/name.txt' );
+```
+
+# Installation
+
+Use `cpan -i File::ShareDir` or cpanm/cpanp equivalent or your operating
+system's package manager.
+
+Alternatively, download the File::ShareDir tarball and do:
+
+```
+perl Makefile.PL
+make
+make test
+sudo make install
+```
+
+# Links and more information
+
+* [MetaCPAN](https://metacpan.org/release/File-ShareDir)
+* [GitHub VCS Repository](https://github.com/perl5-utils/File-ShareDir)
+