search

securesauce / precaution-beta

Precaution provides a simple, automated code review for GitHub projects by running code linters with a security focus on pull requests.
Other
1 stars 0 forks source link

Add Gif to the README #245

Closed MVrachev closed 4 years ago

MVrachev commented 5 years ago

It will be really useful if we add a GIF to the Precaution README. That way we would show how Precaution works in 17 seconds!

Closes: https://github.com/vmware/precaution/issues/106

Signed-off-by: Martin Vrachev mvrachev@vmware.com

joshuagl commented 5 years ago

ImageOptim wraps a bunch of image compression tools in a macOS GUI

MVrachev commented 5 years ago

I tried to export all images in 720 p, them I used ImageOptim as @joshuagl suggested and in the end, I combined them with gifsky. On Gifsky I set it with a quality of 50 %. The result is blurred Gif which is 30 MB in size.

I don't know how to shrink it more.

joshuagl commented 5 years ago

As the Gif is so large and adding large binaries to a git repo isn't good practice, can we instead upload the video to YouTube or similar and embed it in the README?

ericwb commented 5 years ago

How about using git-lfs for this file?

https://help.github.com/en/articles/collaboration-with-git-large-file-storage https://help.github.com/en/articles/configuring-git-large-file-storage

joshuagl commented 5 years ago

This does seem like a good use-case for Git LFS, we gain the benefits of a Gif embedded in the README without having to worry about the impact of a large file on our git repository.