Add minimal README and fix gitignore
This commit is contained in:
4
.gitignore
vendored
4
.gitignore
vendored
@@ -404,6 +404,7 @@ secrets/
|
||||
# Exclude ALL documentation files - this is private development
|
||||
*.md
|
||||
!LICENSE
|
||||
!README.md
|
||||
*.html
|
||||
*.txt
|
||||
|
||||
@@ -416,6 +417,7 @@ PROXMOX_*
|
||||
HOW_TO_*
|
||||
NEXT_*
|
||||
Starting*
|
||||
README_D*
|
||||
|
||||
# Setup and documentation files
|
||||
SETUP_*
|
||||
@@ -423,4 +425,4 @@ CONTRIBUTING*
|
||||
.github/
|
||||
docs/
|
||||
|
||||
# Only keep actual project code, no documentation
|
||||
# Only keep actual project code, no documentation
|
||||
|
||||
45
README.md
Normal file
45
README.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# RedFlag
|
||||
|
||||
**⚠️ PRIVATE DEVELOPMENT - NOT FOR PUBLIC USE**
|
||||
|
||||
This is a private development repository for version retention only.
|
||||
|
||||
## Status
|
||||
|
||||
- **Active Development**: Session 4 in progress
|
||||
- **Not Production Ready**: Do not use
|
||||
- **Breaking Changes Expected**: APIs will change
|
||||
- **No Support Available**: This is not released software
|
||||
|
||||
## What This Is
|
||||
|
||||
A self-hosted, cross-platform update management platform built with:
|
||||
- Go server backend + PostgreSQL
|
||||
- React web dashboard with TypeScript
|
||||
- Linux agents with APT + Docker scanning
|
||||
- Local CLI tools for agent management
|
||||
|
||||
## What This Isn't
|
||||
|
||||
- Not ready for public use
|
||||
- Not documented for external users
|
||||
- Not supported or maintained for others
|
||||
- Not stable (active development)
|
||||
|
||||
## For Developers
|
||||
|
||||
This repository contains:
|
||||
- Server backend code (`aggregator-server/`)
|
||||
- Agent code (`aggregator-agent/`)
|
||||
- Web dashboard (`aggregator-web/`)
|
||||
- Database migrations and configuration
|
||||
|
||||
**Setup**: See local documentation files (not committed to this repo).
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see LICENSE file for details.
|
||||
|
||||
---
|
||||
|
||||
**This is private development software. Use at your own risk.**
|
||||
Reference in New Issue
Block a user