diff --git a/docs/index.md b/docs/index.md index c7a360d..7315eee 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,23 +11,39 @@ Welcome to the documentation for the `ioc-finder` library - a library to find di 📢 *Announcement*: I'm looking for [sponsorship](https://github.com/sponsors/fhightower) for this project. I have a number of improvements and helpful features I'd like to add, but need some support to continue working on this project. If you use this project for work and/or find it useful, please consider [contributing](https://github.com/sponsors/fhightower) even a small amount. Thanks! -## Overview (INTERACTIVE!) +### Quick-Start + +Install ioc-finder: + +```shell +pip install ioc-finder +``` -Copy this example and paste it in the terminal below to get an idea of what this package does: +Use it: ```python from ioc_finder import find_iocs -text = "This is just an foobar.com https://example.org/test/bingo.php" +text = "" iocs = find_iocs(text) iocs['domains'] iocs['urls'] ``` -
+## Overview (INTERACTIVE!) + +Enter some text with IOCs here and click "Parse IOCs" to see how ioc-finder parses IOCs. Click "Reload" + + + + +
+

 
-This terminal uses [Pyodide](https://pyodide.org/en/stable/index.html) to provide a Python3.9 runtime in the browser using [WebAssembly](https://webassembly.org/). Enjoy!
+The code above uses [Pyodide](https://pyodide.org/en/stable/index.html) to provide a Python3.9 runtime in the browser using [WebAssembly](https://webassembly.org/). Enjoy!
 
 ## Capabilities
 
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
index b1ff432..901e107 100644
--- a/docs/overrides/main.html
+++ b/docs/overrides/main.html
@@ -2,160 +2,43 @@
 
 {% block libs %}
     {{ super() }}
-    
-    
-    
-    
-    
 
     
 
+    
+
     
 {% endblock %}