prep readme for public repo

This commit is contained in:
wisplite
2025-11-24 03:11:01 -06:00
parent 204a7e6213
commit da459fadf2
+24 -4
View File
@@ -1,4 +1,4 @@
## Raster: A Simple and Powerful Self-Hosted Photo/Video Management Solution ## Raster: A Simple and Powerful Self-Hosted Media Gallery
Raster is a free and open-source photo/video management solution, with a focus on simplicity where it matters. Raster is a free and open-source photo/video management solution, with a focus on simplicity where it matters.
@@ -8,11 +8,11 @@ I started developing Raster because I found the other self-hosted galleries eith
I wanted a solution that was: I wanted a solution that was:
- Lightweight and easy to run - Lightweight and easy to run
- Simple, clean UI - Simple, clean UI
- Albums, content tags, and descriptions - Had albums, content tags, and descriptions
- Public albums for showcasing work - Public albums for showcasing work
- Private shared albums with multi-user uploads - Private shared albums with multi-user uploads
- Comments and likes in shared albums - Comments and likes in shared albums
- Proper panorama support - Proper panorama/large image support
- Modern tech stack - Modern tech stack
## Quick start ## Quick start
@@ -40,7 +40,27 @@ npm run dev
- `frontend/`: React app (Vite, Tailwind) - `frontend/`: React app (Vite, Tailwind)
## Status ## Status
In early development. Expect rapid updates. Currently supports:
- Creating albums
- Uploading/viewing images
- Protected root user and anon/guest account
Features needed before v1 release:
- Image metadata editing
- Album editing
- Album thumbnails
- Video support
- Image/Album deleting
- User access management
- Mobile support
Planned features for v2:
- Auto-tiling for large images
- Comments and liking
- Image tags
- Smart image search
- Extremely granular configuration
- S3/Cloud bucket storage backend
## Contributing ## Contributing
Issues and PRs are welcome. Issues and PRs are welcome.