Skip to content

Commit d2c16c6

Browse files
docs: add standard documentation files and update README TOC
1 parent 09ca877 commit d2c16c6

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,70 @@
11
# 📊 SwiftUI Data Visualization
22

3+
<!-- TOC START -->
4+
## Table of Contents
5+
- [📊 SwiftUI Data Visualization](#-swiftui-data-visualization)
6+
- [📋 Table of Contents](#-table-of-contents)
7+
- [🚀 Getting Started](#-getting-started)
8+
- [✨ Core Features](#-core-features)
9+
- [📱 Usage & Examples](#-usage-examples)
10+
- [📚 Documentation](#-documentation)
11+
- [🤝 Community](#-community)
12+
- [📊 Project Statistics](#-project-statistics)
13+
- [🚀 Overview](#-overview)
14+
- [🎯 What Makes This Framework Special?](#-what-makes-this-framework-special)
15+
- [🏗️ **Clean Architecture**](#-clean-architecture)
16+
- [🎨 **SOLID Principles**](#-solid-principles)
17+
- [🧪 **Comprehensive Testing**](#-comprehensive-testing)
18+
- [🎯 Key Benefits](#-key-benefits)
19+
- [✨ Key Features](#-key-features)
20+
- [📊 Chart Types](#-chart-types)
21+
- [🎨 Customization](#-customization)
22+
- [⚡ Performance](#-performance)
23+
- [🔄 Interactivity](#-interactivity)
24+
- [📊 Chart Types](#-chart-types)
25+
- [Line Charts](#line-charts)
26+
- [Bar Charts](#bar-charts)
27+
- [Pie Charts](#pie-charts)
28+
- [Scatter Plots](#scatter-plots)
29+
- [🎨 Customization](#-customization)
30+
- [Color Schemes](#color-schemes)
31+
- [Typography](#typography)
32+
- [Animations](#animations)
33+
- [⚡ Performance](#-performance)
34+
- [Large Dataset Optimization](#large-dataset-optimization)
35+
- [Real-time Updates](#real-time-updates)
36+
- [🚀 Quick Start](#-quick-start)
37+
- [Prerequisites](#prerequisites)
38+
- [Installation](#installation)
39+
- [Clone the repository](#clone-the-repository)
40+
- [Navigate to project directory](#navigate-to-project-directory)
41+
- [Install dependencies](#install-dependencies)
42+
- [Open in Xcode](#open-in-xcode)
43+
- [Swift Package Manager](#swift-package-manager)
44+
- [Basic Setup](#basic-setup)
45+
- [📱 Usage Examples](#-usage-examples)
46+
- [Simple Line Chart](#simple-line-chart)
47+
- [Interactive Bar Chart](#interactive-bar-chart)
48+
- [Animated Pie Chart](#animated-pie-chart)
49+
- [🔧 Configuration](#-configuration)
50+
- [Chart Configuration](#chart-configuration)
51+
- [Theme Configuration](#theme-configuration)
52+
- [📚 Documentation](#-documentation)
53+
- [API Documentation](#api-documentation)
54+
- [Integration Guides](#integration-guides)
55+
- [Examples](#examples)
56+
- [🤝 Contributing](#-contributing)
57+
- [Development Setup](#development-setup)
58+
- [Code Standards](#code-standards)
59+
- [📄 License](#-license)
60+
- [🙏 Acknowledgments](#-acknowledgments)
61+
- [📊 Project Statistics](#-project-statistics)
62+
- [📈 Advanced Statistics](#-advanced-statistics)
63+
- [🏆 Project Metrics](#-project-metrics)
64+
- [🌟 Stargazers](#-stargazers)
65+
<!-- TOC END -->
66+
67+
368
<div align="center">
469

570
![Made with ❤️](https://img.shields.io/badge/Made%20with-❤️-red?style=for-the-badge)

SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
If you discover a security vulnerability, please report it responsibly.
4+
5+
## Reporting a Vulnerability
6+
- Do not open public issues for vulnerabilities
7+
- Email the maintainer with steps to reproduce
8+
- We will acknowledge receipt and work on a timely fix
9+
10+
## Supported Versions
11+
Security fixes are applied to the latest mainline branch.

0 commit comments

Comments
 (0)