Skip to content

Commit 845f189

Browse files
author
CIS Guru
committed
Updated documentation.
1 parent 8014b40 commit 845f189

File tree

1 file changed

+34
-42
lines changed

1 file changed

+34
-42
lines changed

README.md

Lines changed: 34 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
# Nine.
22

3-
**Property Management Perfected for Up to Nine Properties**
4-
53
[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/xnodeoncode/nine/releases)
64
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
75
[![.NET](https://img.shields.io/badge/.NET-10.0-purple.svg)](https://dotnet.microsoft.com/)
86
[![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20Windows-lightgrey.svg)](#installation)
7+
[![Website](https://img.shields.io/badge/website-nineapp.co-blue.svg)](https://nineapp.co/)
98

109
---
1110

12-
**Nine.** is a standalone desktop application for landlords managing up to nine residential rental properties. The 9-property limit is our identity, not a limitation — built for independent landlords who want professional-grade tools without the complexity or subscription costs of enterprise solutions.
11+
**Nine.** is a desktop application for real estate investors, property managers, and landlords managing up to nine residential rental properties.
1312

1413
Built with ASP.NET Core 10 and Blazor Server, wrapped in Electron for a native desktop experience.
1514

1615
**Perfect for:**
1716

18-
- Independent landlords with a small portfolio
17+
- Independent property managers and landlords
1918
- Property owners who self-manage their rentals
20-
- New landlords building their first portfolio
21-
- Anyone seeking focused, no-subscription property management software
19+
- New Real Estate investors building their portfolio
20+
- Anyone seeking focused, no-subscription, property management software
2221

2322
## ✨ Key Features
2423

@@ -31,35 +30,30 @@ Built with ASP.NET Core 10 and Blazor Server, wrapped in Electron for a native d
3130

3231
### Tenant Management
3332

34-
- 👥 Complete prospect-to-tenant journey
35-
- 📝 Digital rental applications with screening
36-
- ✅ Application approval workflow
37-
- 🤝 Tenant profiles with contact information
33+
- Track tenants and leases
3834

3935
### Lease Management
4036

4137
- 📄 Digital lease creation and management
42-
- ✍️ Lease offers with acceptance tracking
43-
- 🔄 Multi-lease support (tenants can have multiple active leases)
44-
- 💰 Security deposit investment tracking with annual dividends
38+
- 💰 Security deposit tracking
4539

4640
### Financial Management
4741

48-
- 🧾 Automated rent invoice generation
42+
- 🧾 Generate invoices for active leases
4943
- 💳 Payment tracking by multiple methods
5044
- ⏰ Automatic late fee application after grace period
5145
- 📈 Financial reports and payment history
5246

5347
### Maintenance & Inspections
5448

55-
- 🔧 Maintenance request tracking with vendor assignment
49+
- 🔧 Capture repair services and costs
5650
- ✅ Comprehensive 26-item inspection checklist
5751
- 📅 Scheduled routine inspections
5852
- 📄 PDF inspection reports
5953

6054
### Notifications & Automation
6155

62-
- 🔔 In-app, email, and SMS notifications
56+
- 🔔 In-app notifications
6357
- ⏰ Automatic late fees and lease expiration warnings
6458
- 📅 Background tasks for scheduling and cleanup
6559
- 🎯 Configurable notification preferences
@@ -139,13 +133,13 @@ chmod +x install-desktop-integration.sh
139133

140134
## 📋 System Requirements
141135

142-
| | Minimum | Recommended |
143-
|---|---|---|
144-
| **OS** | Linux (Ubuntu 20.04+) or Windows 10/11 64-bit | Same |
145-
| **CPU** | 2-core, 1.5 GHz | 4-core, 2.5 GHz |
146-
| **RAM** | 2 GB | 4 GB |
147-
| **Disk** | 500 MB | 1 GB |
148-
| **Display** | 1280x800 | 1920x1080 |
136+
| | Minimum | Recommended |
137+
| ----------- | --------------------------------------------- | --------------- |
138+
| **OS** | Linux (Ubuntu 20.04+) or Windows 10/11 64-bit | Same |
139+
| **CPU** | 2-core, 1.5 GHz | 4-core, 2.5 GHz |
140+
| **RAM** | 2 GB | 4 GB |
141+
| **Disk** | 500 MB | 1 GB |
142+
| **Display** | 1280x800 | 1920x1080 |
149143

150144
Nine is distributed as an **AppImage** on Linux (runs on all major distros — no installation required) and a **self-contained .exe** on Windows. All dependencies are bundled.
151145

@@ -163,16 +157,16 @@ Optional: SendGrid (email) and Twilio (SMS) accounts for notifications.
163157

164158
---
165159

166-
## ⚠️ Known Limitations
160+
## ⚠️ Application Limits
167161

168-
Nine. is intentionally constrained:
162+
Nine. is intentionally constrained for an optimal user experience:
169163

170-
| Limitation | Value | Reason |
171-
|---|---|---|
172-
| **Properties** | Maximum 9 | Focused workflows — it's our identity |
173-
| **Users** | Maximum 3 (1 system + 2 login) | Simplified access control |
174-
| **Organizations** | 1 | Desktop application scope |
175-
| **File uploads** | 10 MB per file | Performance management |
164+
| Items | Limit | Reason |
165+
| ----------------- | ------------------------------ | ------------------------------------- |
166+
| **Properties** | Maximum 9 | Focused workflows — it's our identity |
167+
| **Users** | Maximum 3 (1 system + 2 login) | Simplified access control |
168+
| **Organizations** | 1 | Desktop application scope |
169+
| **File uploads** | 10 MB per file | Performance management |
176170

177171
---
178172

@@ -181,9 +175,7 @@ Nine. is intentionally constrained:
181175
- **Framework:** ASP.NET Core 10.0 + Blazor Server
182176
- **Desktop:** ElectronNET 23.6.2
183177
- **Database:** SQLite with SQLCipher AES-256 encryption
184-
- **PDF Generation:** QuestPDF
185-
- **Email:** SendGrid
186-
- **SMS:** Twilio
178+
- **PDF Generation:** QuestPDF (<a href='https://www.questpdf.com/license/community.html' target='_blank'>Community License</a>)
187179
- **UI:** Bootstrap 5.3, Material Design Icons
188180

189181
---
@@ -213,7 +205,8 @@ dotnet test Nine.sln
213205
## 🤝 Contributing
214206

215207
1. **Fork** the repository
216-
2. **Create a feature branch** from `development`: `git checkout -b feature/your-feature`
208+
2. **Create a feature branch** from `development`:
209+
`git checkout -b feature/your-feature`
217210
3. Read **[copilot-instructions.md](.github/copilot-instructions.md)** for architecture guidelines
218211
4. Make changes, write tests, ensure build passes
219212
5. **Submit a pull request** to `development`
@@ -240,7 +233,11 @@ cd 4-Nine && dotnet watch
240233

241234
## 📊 Versioning
242235

243-
[Semantic Versioning](https://semver.org/): **MAJOR** = breaking/schema changes · **MINOR** = new features · **PATCH** = bug fixes
236+
[Semantic Versioning](https://semver.org/):
237+
238+
- **MAJOR** = breaking/schema changes
239+
- **MINOR** = new features
240+
- **PATCH** = bug fixes
244241

245242
**Current version:** 1.0.0 · **Database schema:** 1.0.0
246243

@@ -266,12 +263,6 @@ cd 4-Nine && dotnet watch
266263
- 🎯 Code signing for Windows
267264
- 🎯 Calendar refactoring
268265

269-
### v1.2.0 (Q3 2026)
270-
271-
- 🎯 Tenant portal for online payments and maintenance requests
272-
- 🎯 Enhanced reporting and customization
273-
- 💳 Online rent payment processing (Stripe)
274-
275266
---
276267

277268
## 📜 License
@@ -282,6 +273,7 @@ Copyright © 2026 CIS Guru. Licensed under the **MIT License** — see [LICENSE]
282273

283274
## 📞 Support
284275

276+
- 🌐 **Website:** [nineapp.co](https://nineapp.co/)
285277
- 🐛 **Bug Reports:** [GitHub Issues](https://github.com/xnodeoncode/nine/issues)
286278
- 💡 **Feature Requests:** [GitHub Discussions](https://github.com/xnodeoncode/nine/discussions)
287279
- 🔒 **Security Issues:** cisguru@outlook.com (private)

0 commit comments

Comments
 (0)