From 934866191665fe2e7503820de9a4372f19910f0c Mon Sep 17 00:00:00 2001 From: Akash Manohar J Date: Sun, 7 Jun 2015 00:37:57 +0530 Subject: [PATCH] Documentation about custom shim --- docs/creating-plugins.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/creating-plugins.md b/docs/creating-plugins.md index dad46209..dfcb755f 100644 --- a/docs/creating-plugins.md +++ b/docs/creating-plugins.md @@ -49,3 +49,11 @@ Setup the env to run the binaries in the package. #### bin/uninstall Uninstalls a specific version of a tool. + +### Custom shim templates + +**PLEASE use this feature only if absolutely required** + +asdf allows custom shim templates. For an executable called `foo`, if there's a `shims/foo` file in the plugin, then asdf will copy that file instead of using it's standard shim template. + +This must be used wisely. For now AFAIK, it's only being used in the Elixir plugin, because an executable is also read as an Elixir file apart from just being an executable. Which makes it not possible to use the standard bash shim. \ No newline at end of file