From 6d192adce7ac1c70c70e53bf6153c76c9f145ecf Mon Sep 17 00:00:00 2001
From: "H. Utku Maden" <utkumaden@hotmail.com>
Date: Fri, 30 Aug 2024 17:33:45 +0300
Subject: [PATCH] Add a new README for refile.

---
 ReMime.ReFile/README.md            | 41 ++++++++++++++++++++++++++++++
 ReMime.ReFile/ReMime.ReFile.csproj |  3 ++-
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 ReMime.ReFile/README.md

diff --git a/ReMime.ReFile/README.md b/ReMime.ReFile/README.md
new file mode 100644
index 0000000..bb34eba
--- /dev/null
+++ b/ReMime.ReFile/README.md
@@ -0,0 +1,41 @@
+ReFile - Simple Tool demonstrating ReMime
+=========================================
+
+```
+ReMime Command Line Tool - Determine file Media Type
+
+    refile [-r] file/directory/-...
+
+    file       infer a file
+    directory  infer files in directory. Requires -r
+    -          infer from standard input.
+    -r         search files and folders recursively.
+    -a         include hidden files.
+    -v         verbose mode, use full paths.
+    --list     list known mime types. Will ignore files.
+    --help     show this help text.
+```
+
+ReMime - Simple Media Type Resolution
+=====================================
+ReMime is a very humble library that can identify IANA media types of file
+from their file extension and its content. While being fully extensible
+with your own resolvers, ReMime will also refer to your operating system's
+file type database when resolving files.
+
+Platform Caveats
+----------------
+* On Windows, the default resolver assumes your application has read access to
+  the registry.
+* On Linux, not all `/etc/mime.types` syntax is supported.
+* None of this was written with MacOS in mind. But maybe it'll work?
+
+Refer to `ReMime.ReFile` as an example of how to use the library. Refer to in line
+documentation and the given default resolvers as an example resolver to
+implementations.
+
+Contributing
+------------
+Feel free to contribute your own file type resolvers and bug fixes. The more
+file types that can be detected accurately, the better. Currently the
+repository is available at https://git.mixedup.dev/ReFuel/ReMime. Accepting [email patches](<mailto:sht7ntgni@mozmail.com>).
diff --git a/ReMime.ReFile/ReMime.ReFile.csproj b/ReMime.ReFile/ReMime.ReFile.csproj
index e71432b..054f5c4 100644
--- a/ReMime.ReFile/ReMime.ReFile.csproj
+++ b/ReMime.ReFile/ReMime.ReFile.csproj
@@ -36,7 +36,8 @@
   <ItemGroup>
     <PackageReference Include="ReFuel.ReMime" Version="0.1.0" />
 
-    <Content Include="../*.md" Pack="true" PackagePath="/" />
+    <Content Include="README.md" Pack="true" PackagePath="/" />
+    <Content Include="../LICENSE.md" Pack="true" PackagePath="/" />
     <None Include="../remime_favicon.png" Pack="true" PackagePath="images\icon.png"/>
   </ItemGroup>
 </Project>