philss / rustler_precompiled

Use precompiled NIFs from trusted sources in your Elixir code
182 stars 26 forks source link

docs: improve checksum file explanation with links to examples #16

Closed nbw closed 2 years ago

nbw commented 2 years ago

Based on the conversation from issue #15, this MR adds a bit more explanation for the required checksum configuration along with links to two examples (rustler_precomplication_example and explorer). Personally, I think it's worthwhile to include a link not just to the precomplication example, but to a real-world example like explorer.

The example link assumes that https://github.com/philss/rustler_precompilation_example/pull/3 will be merged.

Thanks

Special thanks to wojtekmach for the help and the mix hex.build --unpack tip.

Docs Screenshot

Screenshot 2022-05-22 at 17 03 40
philss commented 2 years ago

@nbw thank you! :purple_heart: