Skip to content

Commit cc42023

Browse files
authored
Update README.md
1 parent 5ada110 commit cc42023

1 file changed

Lines changed: 47 additions & 2 deletions

File tree

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
1-
# Tracebound
2-
Sitemap-based web crawler that efficiently searches for specific phrases across a website and logs results.
1+
<div align='center'>
2+
3+
<img src="https://fled.dev/assets/tracebound-banner.png" alt="Tracebound" height="300px">
4+
<br><br>
5+
<p>Sitemap-based web crawler that efficiently searches for specific phrases across a website and logs results.</p>
6+
7+
<h4><a href="https://github.com/fled-dev/Tracebound/blob/master/README.md"> Documentation </a> <span> · </span> <a href="https://github.com/fled-dev/Tracebound/issues"> Report Bug </a> <span> · </span> <a href="https://github.com/fled-dev/Tracebound/issues"> Request Feature </a> </h4>
8+
9+
10+
</div>
11+
12+
# Table of Contents
13+
- [About the Project](#about-the-project)
14+
- [Roadmap](#roadmap)
15+
- [License](#license)
16+
- [Contact](#contact)
17+
18+
19+
## About the Project
20+
Sitemaps are fantastic resources, but manually combing through them is tedious. I wanted a quick way to find specific content patterns within a website's structure. Tracebound does just that. It leverages the sitemap to crawl all linked pages efficiently, hunting for any phrase or keyword I specify. It's been a fun little experiment in focused web crawling!
21+
22+
### Screenshots
23+
<a href=""><img src="https://fled.dev/assets/tracebound-demo.png" alt='image' height='300px'></a>
24+
25+
## Getting Started
26+
27+
### Installation
28+
```bash
29+
pip install requirements.txt
30+
```
31+
32+
### Run Locally
33+
```bash
34+
python3 main.py
35+
```
36+
37+
## Roadmap
38+
* [ ] Regular Expression Support
39+
* [ ] Fuzzy Search
40+
* [ ] CSV Export
41+
* [ ] Web Interface
42+
43+
## License
44+
This project is licensed under the MIT License. This means you are free to use, copy, modify, and distribute the software for any purpose, even commercial ones, as long as you include the copyright notice and license information.
45+
46+
## Contact
47+
Paul - - mail@fled.dev

0 commit comments

Comments
 (0)