Add a new README for refile.
This commit is contained in:
parent
75fe42a68d
commit
6d192adce7
41
ReMime.ReFile/README.md
Normal file
41
ReMime.ReFile/README.md
Normal file
@ -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>).
|
@ -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>
|
||||
|
Loading…
Reference in New Issue
Block a user