init

README.md

@@ -0,0 +1,62 @@
+# Generic Keyword Finder
+
+A tool for finding keywords across multiple sources. Yes, I am bad with names.
+
+Goal is to have a modular "poor man's pipeline" to find keywords from different sources. For my use Git does the trick, but it is easy to adjust or add.
+
+## Tasks
+
+- [ ] Write about my current use case
+- [ ] explain what it does and how it works
+- [ ] make the process more dynamic, with sourcing from directories for example
+
+---
+
+## Scripts Overview
+
+### 1. `10_update-repos.sh`
+- **Imports**: `10_git-repos-source-list`
+- **Creates**: `10_repos/` (directory with cloned repositories)
+- **Purpose**: Clones or updates Git repositories from the source list
+
+### 2. `20_merge-sources.sh`
+- **Imports**: `20_source-files-paths`, files listed in the paths file
+- **Creates**: `20_source-list-raw`
+- **Purpose**: Merges multiple source files, sorts and deduplicates entries
+
+### 3. `30_find-keywords.sh`
+- **Imports**: `30_keyword-list`, `20_source-list-raw`, `30_matches-all` (existing matches)
+- **Creates**: `30_matches-all` (updated), `30_matches-new` (new matches only)
+- **Purpose**: Searches for keywords in the merged source list and tracks new matches
+
+### Workflow
+
+1. Run `10_update-repos.sh` to clone/update repositories
+2. Run `20_merge-sources.sh` to consolidate source files
+3. Run `30_find-keywords.sh` to search for keywords and identify new matches
+
+---
+
+## Security
+
+For security concerns or reports, please contact via `hello a t uphillsecurity d o t com` [gpg](https://uphillsecurity.com/gpg).
+
+---
+
+## License
+
+**Apache License**
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/
+
+- ✅ Commercial use
+- ✅ Modification
+- ✅ Distribution
+- ✅ Patent use
+- ✅ Private use
+- ✅ Limitations
+- ❌Trademark use
+- ❌Liability
+- ❌Warranty