update read me

fardage · Jan 30, 2024 · 556d5a8 · 556d5a8
1 parent d0225eb
commit 556d5a8
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 <p align="center">  
   <img src="OrdnerMeister/Assets.xcassets/AppIcon.appiconset/Icon512x512RetinaM.png" alt="Logo" width="80" height="80">
 
-  <h3 align="center">Clasificar</h3>
+  <h3 align="center">OrdnerMeister</h3>
 
   <p align="center">
     An app that helps you sort PDF files into your existing folder structure using a Naive Bayes classifier.
@@ -15,13 +15,10 @@
 
 ## Features
 
-- Automatic sorting of PDF files based on their content using a Naive Bayes classifier.
-- Preserves your existing folder structure while organizing the files.
-- Simple and intuitive user interface.
+Automatically sort PDF files into your existing folder structure using a Naive Bayes classifier. OrdnerMeister will learn from your existing folder structure and use this knowledge to classify new PDF files. The app will show you the results of the classification process and allow you to move the files to the correct folders. If the PDF has not been OCR'd yet, OrdnerMeister will do this for you using Apple's Vision framework.
 
 ## TODO
 
-- [ ] Cache the file text & trained classifier to speed up the classification process.
 - [ ] A nicer UI which shows the progress.
 - [ ] More options for the user to customize the classification process.
 - [ ] Support for more file types.
@@ -31,11 +28,15 @@
 ## Usage
 
 1. Launch the OrdnerMeister app.
-2. Select the folder containing the PDF files you want to sort.
-2. Select the output folder where the sorted PDF files should be moved to.
+2. In the Settings: Select the folder containing the PDF files you want to sort.
+2. In the Settings: Select the output folder where the sorted PDF files should be moved to.
 3. Click the "Run" button to start the classification and sorting process.
 4. OrdnerMeister will show you the results of the classification process.
 
 ## Contributing
 
 Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.
+
+## Thanks
+
+- https://github.com/fcanas/Bayes