diff --git a/README.md b/README.md index 694933f..e69de29 100644 --- a/README.md +++ b/README.md @@ -1,42 +0,0 @@ ---- - -### **Overview** -This repository will host the source code for a GitHub app designed to detect sensitive data within repositories. The app automatically scans files for personal, health, and other critical data types, ensuring compliance with privacy regulations and reducing the risk of data exposure. - -### **Features** -- **Automated Scanning**: Identifies sensitive data patterns in text, PDFs, images, and more. -- **GitHub Integration**: Triggered by repository events, such as file uploads, commits, or pull requests. -- **Detailed Reports**: Provides actionable insights and flags files containing sensitive information, and how to resolve them. -- **Automated Questionnaire Form**: Every pull request has a questionnaire automatically pushed to educate developers and users. - -### **Expected Supported File Types (so far)** -- Text files (`.txt`) -- PDF documents (`.pdf`) -- Word files (`.docx`) -- Images (`.png`, `.jpg`, `.jpeg`) -- Comma Seperated Value files (`.csv`) -- Other file types (expandable based on requirements) - -### **Goals** -- Enhance and prevent sensitive data concerns for GitHub repositories. -- Assist developers in identifying and mitigating risks related to sensitive data exposure. -- Comply with privacy standards like GDPR, HIPAA, and others. - -### **Getting Started** -- TBD - - -echo "Workflow test trigger" >> README.md - - -### **Contributing** ---- -#### IMPORTANT!! -To contribute to this repository, you **must** fork this repo, clone your fork and develop on your own forked repository, then PR into this. -do not clone from this repository directly ---- -### **License** -This repository is licensed under [your chosen license]. See the `LICENSE` file for more details. - ---- -