Added README File

2024-12-24 13:09:31 -05:00
parent e40432a510
commit ff9697f35b
1 changed files with 26 additions and 0 deletions
@@ -0,0 +1,26 @@
+![Rust Badge](https://img.shields.io/badge/Rust-000000?style=for-the-badge&logo=rust&logoColor=white)
+
+![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)
+
+# pdf-parse
+
+A cross platform non multithreaded PDF parser/text parser to search inside PDF documents for certain strings built in Rust.
+
+## Screenshots
+
+![App Screenshot](https://github.com/yvnggodemis/pdf-parse/raw/main/images/example.png)
+
+
+## Documentation
+
+1. Click "Open Directory"
+2. Type in the string you want to search for
+3. Click search
+\
+ **Warning - This may appear to hang because it is not multithreaded. I am by no means a rust developer I'm just doing it for fun. Any help on this or pull requests would be appreciated, but it does what it's supposed to do.**
+
+
+## Acknowledgements
+
+ - [Icon](https://www.flaticon.com/free-icons/pdf)
+ - [GUI (Slint)](https://slint.dev/)