Skip to content

Commit 525dc74

Browse files
author
CalorieApp Maintainer
committed
docs: improve README structure and expand change notes for v1.1.2
- README: added feature matrix, updated version badge to 1.1.2, concise pre-release disclaimer, architecture clarity - CHANGELOG: unified entries for 1.1.2, 1.1.1, 1.1.0 with added details (removed premature instructions, social asset generator, branch deprecations) No runtime/build commands reintroduced; documentation now reflects pre-release policy.
1 parent 1b3c9a0 commit 525dc74

2 files changed

Lines changed: 63 additions & 96 deletions

File tree

CHANGELOG.md

Lines changed: 39 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
11
## [1.1.2] - 2025-11-19
22

33
### Added
4-
- Dynamic social image generator with edge-to-edge typography (font fitting, glow)
5-
- Consolidated social copy file (`docs/SOCIAL_COPY_2025-11-19.md`)
6-
- Visual audit checklist (`docs/VISUAL_AUDIT_CHECKLIST_v1.1.2.md`)
7-
- PR body template for visual refinement branch
4+
- Dynamic social image generator (`tools/generate_social_image.py`) with edge‑to‑edge adaptive typography & glow layers
5+
- Consolidated multi‑platform social copy (`docs/SOCIAL_COPY_2025-11-19.md`)
6+
- Visual audit checklist (`docs/VISUAL_AUDIT_CHECKLIST_v1.1.2.md`) for structured refinement tracking
7+
- PR body template (`docs/PR_BODY_feature_visual_refinement_v1.1.2.md`)
8+
- Deprecated branch index (`docs/DEPRECATED_BRANCHES.md`)
89

910
### Changed
10-
- Updated Telegram community invite link across all docs/config metadata
11-
- Enhanced marketing asset generation performance (coarser gradient steps)
12-
- Version badge styling widened for higher impact
11+
- README & public docs: removal of premature run/build instructions (pre‑release policy enforcement)
12+
- Global Telegram community link updated across all documentation & metadata
13+
- Social image generation performance (coarser gradient); robust font discovery (Windows + Pillow bundles)
14+
- Version badge updated to 1.1.2
15+
16+
### Removed
17+
- Direct executable examples (`python main.py`, `buildozer android debug`) from public README/docs
18+
19+
### Security / Compliance
20+
- Reaffirmed pre‑release distribution boundaries (no APK guidance until stability milestone)
1321

1422
### Notes
15-
- This release focuses on outward-facing visual communication and readiness for social distribution.
16-
- Remaining planned refinement tasks moved to upcoming version placeholder.
23+
- Focused on outward visual communication & brand consistency rather than core feature expansion.
24+
- Pending refinement tasks deferred to 1.1.3.
1725

1826
## [1.1.3] - Unreleased
1927

@@ -31,19 +39,16 @@
3139
---
3240
## [1.1.1] - 2025-11-18
3341

34-
### Repository Hardening & Public-Safe Docs
35-
36-
#### Added
37-
- OFFICIAL_PROJECT_DOCS.md: Canonical, public-safe documentation index
38-
- STATUS_UPDATE_2025-11-18.md: Public snapshot of progress
42+
### Added
43+
- `OFFICIAL_PROJECT_DOCS.md` public‑safe index
44+
- `STATUS_UPDATE_2025-11-18.md` progress snapshot
3945

40-
#### Changed
41-
- README.md: Removed links to private reference files; added official docs index
42-
- docs/README.md: Switched to external references; added official docs index
43-
- .gitignore: Allowlisted public UX tour guides while keeping internal files private
46+
### Changed
47+
- README & docs index alignment; canonical documentation entry point introduced
48+
- `.gitignore` adjustments: whitelist safe UX tour guides, preserve internal artifacts privacy
4449

45-
#### Privacy
46-
- Reaffirmed separation between public documentation and private implementation/testing artifacts
50+
### Privacy
51+
- Reinforced segregation between public documentation & internal implementation/testing assets
4752

4853
---
4954
# Changelog
@@ -53,49 +58,25 @@ All notable changes to CalorieApp will be documented in this file.
5358
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5459
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5560

56-
## [1.1.0] - 2025-11-18
57-
58-
### 🎉 Official CalorieToken Branding Integration
59-
60-
**Major Update:** This release officially integrates CalorieToken® branding, legal compliance, and trademark protections as we move toward public launch.
61+
## [1.1.0] - 2025-11-16
6162

6263
### Added
63-
64-
#### Legal & Compliance
65-
-**Custom Dual License** - Clarified licensing terms for personal vs. commercial use
66-
-**Trademark Guidelines** - Official CalorieToken® trademark usage policies (EUIPO registered)
67-
-**Legal Entity Information** - Chamber of Commerce KVK: 84216352 (Netherlands)
68-
-**Official Project Links** - Comprehensive links to CalorieToken resources
69-
70-
#### CalorieToken Integration
71-
-**Official XRPL Token Details**
72-
- Mainnet Issuer: `rNqGa93B8ewQP9mUwpwqA19SApbf62U7PY`
73-
- Currency: Calorie ($CAL)
74-
- Network: XRP Ledger Mainnet + Testnet support
75-
-**Project Reference Documentation** - Complete token specifications
76-
-**Community Links** - Twitter, Telegram, Discord, and more
77-
-**Trading Platform Integration** - Links to Sologenic, XPMarket, LiveCoinWatch
78-
79-
#### Developer Resources
80-
-**GitHub Funding Configuration** - Support development via XRPL
81-
-**Enhanced Metadata** - Updated `pyproject.toml` and `setup.py`
82-
-**Official Website Badge** - Direct link to calorietoken.net
64+
- Mnemonic (BIP39) 12‑word wallet recovery system
65+
- Generic token framework + trustline management screen
66+
- Unified UI headers & transaction visual indicators
67+
- Multi‑server XRPL failover connectivity layer
68+
- Password visibility toggle components
69+
- Initial NFT & DEX screen scaffolds
70+
- CalorieToken branding integration (issuer verification, badges, trademark docs)
8371

8472
### Changed
73+
- README & LICENSE updated for Custom Dual License + trademark notice
74+
- Consolidated header/layout strategy across 25+ screens
75+
- Transaction history formatting & short address styling
8576

86-
#### Documentation
87-
- 🔄 **README.md** - Added CalorieToken integration section and corrected license badge
88-
- 🔄 **LICENSE** - Enhanced with trademark notices and official contact information
89-
- 🔄 **Project Metadata** - Aligned all package information with CalorieToken branding
90-
91-
#### Branding
92-
- 🎨 **Badge Updates** - Fixed license badge from MIT to Custom Dual
93-
- 🎨 **Footer Information** - Added CalorieToken trademark notice
94-
- 🎨 **Contact Details** - Official info@calorietoken.net throughout
95-
96-
### Security
97-
- 🔒 **Issuer Verification** - Documented official XRPL issuer address to prevent fake tokens
98-
- 🔒 **Legal Protection** - Trademark registration information for brand protection
77+
### Security / Compliance
78+
- Official issuer address documented to mitigate spoofing
79+
- Custom Dual License + trademark usage guidelines published
9980

10081
---
10182

README.md

Lines changed: 24 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![CI](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ci.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ci.yml)
44
[![CodeQL](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/codeql.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/codeql.yml)
55
[![UX Tour](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ux_tour.yml/badge.svg)](https://github.com/CalorieToken/CalorieAppTestnet/actions/workflows/ux_tour.yml)
6-
[![Version](https://img.shields.io/badge/version-1.1.1-blue.svg)](https://github.com/CalorieToken/CalorieAppTestnet)
6+
[![Version](https://img.shields.io/badge/version-1.1.2-blue.svg)](https://github.com/CalorieToken/CalorieAppTestnet)
77
[![Python](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/)
88
[![License](https://img.shields.io/badge/license-Custom%20Dual-orange.svg)](LICENSE)
99
[![Website](https://img.shields.io/badge/website-calorietoken.net-green.svg)](https://calorietoken.net)
@@ -31,39 +31,27 @@ A mobile-first cryptocurrency wallet and food tracking application for **Calorie
3131
- [Trademark Guidelines](docs/TRADEMARK.md) - Usage policies
3232
- [CalorieToken Website](https://calorietoken.net) - Official resources
3333

34-
## 🌟 Features
35-
36-
### 🔐 Wallet Functionality
37-
- **Multi-Wallet Support**: Create and import multiple XRPL wallets
38-
- **Mnemonic Recovery**: 12-word BIP39 mnemonic phrase support for wallet backup/recovery
39-
- **Secure Storage**: Encrypted wallet data with password protection
40-
- **Balance Tracking**: Real-time XRP and custom token balances
41-
- **Transaction History**: Complete transaction tracking with visual indicators
42-
43-
### 💸 Transactions
44-
- **XRP Payments**: Send and receive XRP with multi-server failover
45-
- **Token Support**: Generic token system for custom XRPL tokens
46-
- **Trustline Management**: Add and manage XRPL trustlines
47-
- **Robust Connectivity**: Automatic failover between multiple XRPL servers
48-
- **Error Handling**: Graceful degradation with offline mode support
49-
50-
### 🎨 NFT Features
51-
- **NFT Minting**: Create and mint NFTs on the XRPL
52-
- **Custom Metadata**: Full control over NFT properties and metadata
53-
54-
### 📊 DEX Trading
55-
- **Decentralized Exchange**: Trade tokens directly on the XRPL DEX
56-
- **Market Making**: Create and manage trading offers
57-
58-
### 🍽️ Food Tracking
59-
- **Calorie Monitoring**: Track daily food intake and calories
60-
- **Nutrition Data**: Comprehensive food database integration
61-
62-
### ⚙️ Advanced Features
63-
- **Conditional Navigation**: Intelligent navigation system that only creates drawers when needed
64-
- **Performance Optimized**: Resource-efficient design with minimal memory footprint
65-
- **Multi-Server XRPL**: Automatic failover between testnet servers
66-
- **Password Visibility**: Enhanced UX with eye icon toggles
34+
## 🌟 High-Level Feature Matrix
35+
36+
| Area | Implemented | Notes |
37+
|------|-------------|-------|
38+
| Multi‑Wallet XRPL || Create/import; encrypted storage |
39+
| Mnemonic (BIP39) || 12‑word generation, verify, import |
40+
| Token Support || Generic framework + trustlines |
41+
| Transactions || XRP & tokens; visual history indicators |
42+
| Offline Mode || Deterministic tours/testing |
43+
| Multi‑Server Failover || Rotating endpoints, graceful degradation |
44+
| NFT Screens || Mint flow refinement pending |
45+
| DEX Trading || Offer & market UI polishing |
46+
| Food Tracking || Nutrition logging baseline |
47+
| Responsive System || Size classes, lazy recompute, overlay (withheld) |
48+
| Social Assets || Dynamic image generator (edge‑to‑edge typography) |
49+
| Accessibility | 🚧 | Contrast audit scheduled |
50+
| Performance Profiling | 🚧 | Planned instrumentation |
51+
| CalorieDB Sync | 🔜 | Deferred indexing & storage phase |
52+
| WalletConnect | 🔜 | Phase 1 design queued |
53+
54+
Legend: ✅ Complete · ⏳ Partial · 🚧 In Progress · 🔜 Planned
6755

6856
## 🛠️ Technical Stack
6957

@@ -141,11 +129,9 @@ Robust connectivity with automatic failover:
141129
### XRPL Response Caching
142130
Lightweight in-memory caching for select XRPL requests (e.g. `ServerInfo`) reduces redundant network calls and stabilizes performance under intermittent connectivity. Cache entries automatically expire after a short TTL.
143131

144-
## 🚀 Getting Started (Public-Safe)
145-
146-
> Execution and build instructions are intentionally withheld until a stable, review-approved release milestone. The repository at this stage is for transparency of progress, documentation, and ongoing refactor history — not for end-user execution or distribution.
132+
## 🚀 Getting Started (Pre-Release Notice)
147133

148-
If you are an authorized collaborator and require internal run/build procedures, request access privately (info@calorietoken.net). All prior direct run examples (e.g. `python main.py`, `buildozer android debug`) have been removed to prevent premature usage of unfinished systems.
134+
Runtime/build commands have been deliberately removed (v1.1.2) to prevent distribution of unfinished work. Request internal access: info@calorietoken.net.
149135

150136
## 📱 Usage
151137

0 commit comments

Comments
 (0)