X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;f=README.md;h=82b252b1657a0b5aff8328133d5e8d9002e66bc0;hb=eb21562c5c37f1ae6b8f1f5138c6efefdd12e17a;hp=356447d6ec34cb7aff27af821faab4ebc5525e39;hpb=e4dd547cd810ab0038485cbff07345e704b04830;p=hotformathCLI%2F.git diff --git a/README.md b/README.md index 356447d..82b252b 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,16 @@ For instalation you just need to download and run the most recent release direct `go build hotformathCLI.go` should be enough # How does this work? + +## How to use? +![usage](./working.gif) +> Now you can do with those results whatever you please + +In this case on the third link you cna find a very interesting gif of andromeda, as promised. +you can check in there to see what else there is. +https://www.hep.ucl.ac.uk/~clarke/ParticlePhysicsMaterial/ + +## What is inside? This project uses [rocketlaunchr's google-search module](github.com/rocketlaunchr/google-search) to search google for a term introduced by the user and then scraps the first 3 results the query sent to google shoul look a little something like `intext:"[YOUR SEARCH TERM]" -inurl:(jsp|pl|php|html|aspx|htm|cf|shtml) -inurl:(index_of|listen77|mp3raid|mp3toss|mp3drug|index_of|wallywashis) intitle:"index.of./" [specific modifier]` where the specific modifier depends on the flag you use @@ -37,5 +47,5 @@ In the future we plan to: - [ ] TUI with https://github.com/charmbracelet/ repos # Credits -![HotForMath](logo.png) +![HotForMath](./hotformath.png) [HOTFORMATH ON GITHUB](https://github.com/marcosfermin/hotformath)