Updated README.md

This commit is contained in:
Max W. 2024-05-26 10:45:58 +02:00
parent 829ffa18a6
commit dcd9879af6

View File

@ -1,11 +1,30 @@
# A desktop webapp for clearing sensitive data from text # Standalone WebApp for Clearing Sensitive Data from Text
The default template for a Neutralinojs app. It's possible to use your favorite frontend framework by using [these steps](https://neutralino.js.org/docs/getting-started/using-frontend-libraries). This is a standalone web application designed to clear sensitive data from text. It's an essential tool for anyone working with AI, as it helps to ensure that the data used for training and testing is free of any sensitive or personally identifiable information.
## Features
- Clear sensitive data from text: The application provides a simple and intuitive interface for clearing sensitive data from any text input.
- Auto copy to clipboard: The cleared text is automatically copied to the clipboard for easy use.
- Customizable filters: The application comes with a set of predefined filters for common types of sensitive data, and users can enable or disable these filters as needed.
## Compatibility
The application is built with Neutralinojs, a lightweight and portable framework that allows it to run on any operating system. Whether you're using Windows, macOS, or Linux, you can use this application to clear sensitive data from your text.
## Getting Started
To get started with this application, simply download the latest release from the GitHub repository and run the executable file. The application will open in your default web browser, and you can start clearing sensitive data from your text right away.
## License ## License
[MIT](LICENSE) This project is licensed under the MIT License. See the `LICENSE` file for more details.
## Icon credits ## Credits
- `trayIcon.png` - Made by [Freepik](https://www.freepik.com) and downloaded from [Flaticon](https://www.flaticon.com) - Bootstrap - The CSS framework used for styling the application. [Bootstrap GitHub](https://github.com/twbs/bootstrap)
- jQuery - The fast, small, and feature-rich JavaScript library used in the project. [jQuery GitHub](https://github.com/jquery/jquery)
- animate.css - A cross-browser library of CSS animations. [animate.css GitHub](https://github.com/animate-css/animate.css)
- NeutralinoJS - The lightweight and portable framework used to build this application. [NeutralinoJS GitHub](https://github.com/neutralinojs/neutralinojs)
- Bootstrap icons - Used for the icons in the application. [Bootstrap icons GitHub](https://github.com/twbs/icons)
- DALL-E3 by OpenAI - Used for generating all visible images/graphics. [DALL-E3 GitHub](https://github.com/openai/DALL-E)