mimetype-xml 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04043c93603866f7953f9fc63575f06dbf497131
-  data.tar.gz: 82188810733908e58cf7cd50051aa8480761844e
+  metadata.gz: 48f3e79194d0fef31b28e1f54d678533b39733cd
+  data.tar.gz: 7ba741ff3e85e93cc14564dd37d23ed838cc994d
 SHA512:
-  metadata.gz: 6084b5f83c3d3f667a76078b6e64ec1206c51e075744b48c661b3817792b523689a09e30011e8ca3197108510d4d52050aad9a23629112a8daa647e5c07eda4a
-  data.tar.gz: 2167b16e30ad942c9295f6e476740ebf3c21a0036eb93ef5f35adb56f59cc462f880ef6d78ce9d268487ecd019841706339435c27c35875e41f5f9609b70e934
+  metadata.gz: 7a7feb2cd9eba3ab98e05f4fdf4dc9cfa70d58110924fd3a18870236141434dcc0b2f73be284c652c99cffe990b8301e2e42e91cabb7926611a10ed10babf5c4
+  data.tar.gz: 7e91383ec462db8c3b7f4e0b4db94ad95e714d3a5e00fa5a9351313de71f9f21a180150e133f5a14f2a8593e73abb91613c865aaf9526a9763bd1697e5e3292e

data/README.md

@@ -1,2 +1,76 @@
-# mimetype-xml
-Custom mimetype from TOML to XML
+# MimetypeXML
+> Custom mimetype from TOML to XML
+
+## Install
+
+- You need Ruby and Gems (gems comes with ruby)
+Install this gem with
+```shell
+gem install mimetype-xml 
+
+# You might want to run this with sudo,
+# or add the Gem userdir to the beginning of your $PATH variable
+# like so in your bashrc: `PATH=$(ruby -e 'print Gem.user_dir')/bin:$PATH`
+# This depends on your platform.
+```
+
+## Usage
+Create the TOML config (`./custom-mime.toml`):
+```toml
+## CUSTOM MIMETYPES TOML CONFIG FILE ##
+# Optional variables ard marked with `(opt.)` in a
+# comment at the end of the line
+
+# Add mimetype for elixir files
+[x-application-elixir]
+
+type    = "application/x-elixir"
+pattern = ["*.ex", "*.exs"] # Always in an array
+                            # (even if only one pattern, e.g. ["*.ext"])
+
+comment      = "Elixir File" # Default language
+comment_lang = [ ["no", "Elixir Fil"], ["la", "Ordo Elixir"] ] # etc. (opt.)
+
+icon = "mimetypes/application-x-elixir.svg"
+size = 48 # I don't really know
+
+xml_file = "elixir-file-mimetype.xml" # (opt.), not useful...
+
+
+# Another for crystal files
+
+[x-application-crystal]
+type = "application/x-crystal"
+pattern =  [".cr"]
+comment = "Crystal File"
+icon = "mimetypes/application-x-crystal.svg"
+size = 48
+
+# That simple to add new mimetypes, just make the icon in the
+# path specified in the `icon` variable. 
+# e.g. 'mimetypes/appliaction-x-myfile.svg'
+```
+
+Then generate the xml files and install it through a ruby script (`./generate-mimetypes.rb`):
+```ruby
+require 'mimetype_xml'
+require 'toml' # `toml` comes with this gem (`mimetype_xml`)
+
+xml = MimetypeXML::Generate.toml_file(
+  :file      => './custom-mime.toml', # The location of the TOML config
+  :xml_dir   => './.xml', # Choose somewhere, make sure the dir exists
+  :icon_pack => '~/.icons/YOUR_ICON_PACK' # Replace this with the install dir of your iconpack
+)
+
+files = xml.write_files
+files.install
+```
+
+Then run the script from your shell:
+```shell
+ruby ./generate-mimetypes.rb
+```
+
+---
+
+The binary file doesn't do anything at the moment.

data/bin/mimetype-xml

@@ -1 +1,2 @@
 #!/usr/bin/env ruby
+puts "This command doesnt work at the moment,\nGithub repo:,\nGithub repo: https://github.com/Demonstrandum/mimetype-xml"

data/lib/mimetype_xml.rb

@@ -6,7 +6,7 @@ require_relative 'mimetype_xml/xml'
 require_relative 'mimetype_xml/generate'
 
 module MimetypeXML
-  VERSIONS = { :major => 1, :minor => 1, :tiny => 1 }
+  VERSIONS = { :major => 1, :minor => 1, :tiny => 2 }
 
   def self.version *args
     VERSIONS.flatten.select.with_index { |val, i| i.odd? }.join '.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mimetype-xml
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Demonstrandum