Skip to content

Commit fc994ed

Browse files
committed
feat: update README with SaaS details and self-hosting instructions
- Added a new section for getting started with the official SaaS, highlighting its benefits and ease of use. - Expanded the self-hosting section to clarify requirements and provide a tip for users to consider the SaaS option. - Included links to official documentation for further guidance on setup and advanced usage. - Updated related links to reflect the official SaaS and documentation resources. Signed-off-by: Innei <[email protected]>
1 parent b6ec788 commit fc994ed

File tree

1 file changed

+36
-3
lines changed

1 file changed

+36
-3
lines changed

README.md

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,26 @@ Afilmory (/əˈfɪlməri/, "uh-FIL-muh-ree") is a term created for personal phot
88

99
A modern photo gallery website built with React + TypeScript, supporting automatic photo synchronization from multiple storage sources (S3, GitHub), featuring high-performance WebGL rendering, masonry layout, EXIF information display, thumbnail generation, and more.
1010

11-
Live Photo Galleries:
11+
## 🚀 Get Started in Seconds
12+
13+
**👉 [Use the Official SaaS](https://afilmory.art/) - No setup required!**
14+
15+
The easiest way to create your photo gallery is through our hosted service at **[afilmory.art](https://afilmory.art/)**. Sign up, connect your storage, and your gallery is live in minutes—no deployment, no servers, no maintenance.
16+
17+
### Why Use the Official SaaS?
18+
19+
-**Zero setup** - No configuration, no deployment, no infrastructure management
20+
-**Live CMS** - Edit photos, titles, and metadata in real-time without rebuilding
21+
-**Custom domains** - Bind your own domain with DNS verification
22+
-**Automatic updates** - Always running the latest version with new features
23+
-**Managed infrastructure** - We handle scaling, backups, and maintenance
24+
-**Built-in billing** - Flexible plans with usage-based pricing
25+
26+
[**Get Started Now →**](https://afilmory.art/)
27+
28+
---
29+
30+
### Live Photo Galleries
1231

1332
- https://afilmory.innei.in
1433
- https://gallery.mxte.cc
@@ -77,7 +96,11 @@ Designed with adapter pattern, supporting multiple storage backends:
7796
- **Eagle Storage** - Using Eagle app library as image storage
7897
- **Local File System** - Local storage for development and testing
7998

80-
## 🚀 Self-Host
99+
## 🛠️ Self-Host (Advanced)
100+
101+
If you prefer to host Afilmory yourself, you can deploy it on your own infrastructure. This requires more technical knowledge and ongoing maintenance.
102+
103+
> **💡 Tip**: For most users, we recommend using the [official SaaS](https://afilmory.art/) instead. Self-hosting is best suited for developers who need full control over their deployment or have specific infrastructure requirements.
81104
82105
### Option A: Docker (recommended)
83106

@@ -91,6 +114,8 @@ Designed with adapter pattern, supporting multiple storage backends:
91114

92115
Looking for developer commands, environment variables, and builder config details? See `DEVELOPMENT.md`.
93116

117+
For detailed self-hosting instructions, see the [Documentation](https://docs.afilmory.art).
118+
94119
## 🔧 Advanced Usage
95120

96121
### Custom Storage Provider
@@ -128,9 +153,17 @@ export async function customImageProcessor(buffer: Buffer) {
128153

129154
Attribution Network License (ANL) v1.0 © 2025 Afilmory Team. See [LICENSE](LICENSE) for more details.
130155

156+
## 📚 Documentation
157+
158+
- **[Official Documentation](https://docs.afilmory.art/)** - Complete guides, API reference, and tutorials
159+
- **[Quick Start Guide](https://docs.afilmory.art/getting-started/quick-start)** - Get your gallery running in 5 minutes
160+
- **[SaaS Mode](https://docs.afilmory.art/saas)** - Learn about hosted galleries and multi-tenant features
161+
- **[Storage Providers](https://docs.afilmory.art/storage/providers)** - Setup guides for S3, GitHub, B2, and more
162+
- **[Deployment Guides](https://docs.afilmory.art/deployment)** - Deploy to Vercel, Cloudflare Pages, Docker, and more
163+
131164
## 🔗 Related Links
132165

133-
- [Live Demo](https://afilmory.innei.in)
166+
- [Official SaaS](https://afilmory.art/)
134167
- [Personal Website](https://innei.in)
135168
- [GitHub](https://github.com/innei)
136169

0 commit comments

Comments
 (0)