Skip to content

Commit d7aec45

Browse files
committed
modified: README.md
1 parent 92d1491 commit d7aec45

File tree

1 file changed

+65
-23
lines changed

1 file changed

+65
-23
lines changed

README.md

Lines changed: 65 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ docsingest /path/to/documents -v
8888

8989
### Advanced Features
9090

91-
9291
#### Comeplete Options List
9392
```bash
9493
usage: docsingest [-h] [-o OUTPUT] [--agent AGENT] [-p PROMPT] [--no-pii-analysis] [-v] [--compress] [--compression-level COMPRESSION_LEVEL] directory
@@ -111,6 +110,7 @@ options:
111110
--compression-level COMPRESSION_LEVEL
112111
Compression level (0-1)
113112
```
113+
114114
#### Content Compression
115115
```bash
116116
# Enable content compression
@@ -200,28 +200,52 @@ DocsIngest provides a robust, multi-layered approach to regulatory compliance an
200200
- Identification of sensitive and regulated content
201201
- Contextual risk scoring
202202

203-
## 📦 Version Information
204-
205-
**Current Version**: 1.1.0
206-
**Last Updated**: 2025-01-06
207-
**Maintained by**: Marc Shade (marc@2acrestudios.com)
208-
209-
## 🤝 Contributing
210-
211-
As the primary developer, I manage this project with a focus on continuous improvement and innovation. Contributions are welcome through collaborative discussions and iterative development.
212-
213-
## 📄 License
214-
215-
Proprietary software. All rights reserved.
216-
217-
## 🚀 Roadmap
218-
219-
- [x] Support more file types
220-
- [ ] Enhanced token estimation
221-
- [ ] Web interface
222-
- [ ] Cloud storage integration
223-
- [ ] Advanced AI prompt customization
224-
- [ ] Support for additional specialized file formats (e.g., .rtf, .odt)
203+
2. **Compliance Risk Evaluation**
204+
- Detect potential regulatory violations
205+
- Flag documents with high-risk content
206+
- Generate detailed compliance reports
207+
208+
3. **Proactive Monitoring**
209+
- Continuous document scanning
210+
- Real-time alerts for compliance breaches
211+
- Audit trail generation
212+
213+
### 🔒 Supported Compliance Domains
214+
- GDPR (General Data Protection Regulation)
215+
- HIPAA (Health Insurance Portability and Accountability Act)
216+
- CCPA (California Consumer Privacy Act)
217+
- SOX (Sarbanes-Oxley Act)
218+
- PCI DSS (Payment Card Industry Data Security Standard)
219+
- NIST Framework
220+
- ISO 27001 Information Security Management
221+
222+
### 🚨 Key Compliance Capabilities
223+
- **Advanced PII Detection**
224+
- Identify sensitive personal information
225+
- Support for multiple PII categories:
226+
* Names
227+
* Email addresses
228+
* Phone numbers
229+
* Social Security Numbers
230+
* Credit card numbers
231+
- **Intelligent Redaction**
232+
- Automatic masking of sensitive information
233+
- Configurable redaction levels
234+
- **Comprehensive Compliance Reporting**
235+
- Detailed risk assessment
236+
- Actionable compliance recommendations
237+
- **Multi-Regulation Support**
238+
- Compliance checks for GDPR, FERPA, COPPA
239+
- Proactive regulatory alignment
240+
241+
### 🔍 Compliance Verification Process
242+
1. Document Ingestion
243+
2. Automated PII Scanning
244+
3. Risk Assessment and Scoring
245+
4. Compliance Reporting
246+
5. Optional Redaction
247+
248+
**Note**: While DocsIngest provides powerful compliance tools, it is not a substitute for professional legal or compliance advice. Always consult with compliance experts for your specific regulatory requirements.
225249

226250
## 🔧 Development
227251

@@ -240,3 +264,21 @@ pip install -r requirements-dev.txt
240264

241265
# Run tests
242266
pytest tests/
267+
```
268+
269+
## 🤝 Contributing
270+
271+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
272+
273+
## 📄 License
274+
275+
MIT License
276+
277+
## 🚀 Roadmap
278+
279+
- [x] Support more file types
280+
- [ ] Enhanced token estimation
281+
- [ ] Web interface
282+
- [ ] Cloud storage integration
283+
- [ ] Advanced AI prompt customization
284+
- [ ] Support for additional specialized file formats (e.g., .rtf, .odt)

0 commit comments

Comments
 (0)