Skip to content

Your favorite shift management application!

docs: update README to include color coding and password protection features

panteLxe0dde42bc1e7
diff --git a/README.md b/README.md
index f80180b..e871d75 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# BetterShift
-A modern shift management application built with Next.js and SQLite. BetterShift helps you organize and manage work shifts across multiple calendars with customizable presets.
+A modern shift management application built with Next.js and SQLite. BetterShift helps you organize and manage work shifts across multiple calendars with customizable presets, color coding, and password protection.
## Features
@@ -9,19 +9,10 @@ A modern shift management application built with Next.js and SQLite. BetterShift
- 🎨 **Color Coding**: Assign colors to calendars for better visualization
- πŸ“‹ **Shift Presets**: Create reusable shift templates for faster scheduling
- πŸ—“οΈ **Calendar View**: Interactive monthly calendar with week-based layout
+- πŸ”’ **Password Protection**: Secure calendars with optional passwords
- πŸ’Ύ **SQLite Database**: Lightweight, file-based database with Drizzle ORM
- 🐳 **Docker Support**: Easy deployment with Docker and Docker Compose
-## Tech Stack
-
-- **Framework**: [Next.js 16](https://nextjs.org/) with React 19
-- **Database**: SQLite with [Drizzle ORM](https://orm.drizzle.team/)
-- **Styling**: [Tailwind CSS 4](https://tailwindcss.com/)
-- **UI Components**: [Radix UI](https://www.radix-ui.com/)
-- **Date Handling**: [date-fns](https://date-fns.org/)
-- **Icons**: [Lucide React](https://lucide.dev/)
-- **TypeScript**: Full type safety
-
## Prerequisites
- Node.js 20+ (for local development)
@@ -110,67 +101,6 @@ npm run db:push
npm run db:studio
```
-### Database Location
-
-- **Development**: SQLite database file location depends on your configuration
-- **Production/Docker**: `./data/sqlite.db` (persisted in the `data` volume)
-
-## Project Structure
-
-```
-bettershift/
-β”œβ”€β”€ app/ # Next.js app directory
-β”‚ β”œβ”€β”€ api/ # API routes
-β”‚ β”‚ β”œβ”€β”€ calendars/ # Calendar endpoints
-β”‚ β”‚ β”œβ”€β”€ presets/ # Preset endpoints
-β”‚ β”‚ └── shifts/ # Shift endpoints
-β”‚ β”œβ”€β”€ globals.css # Global styles
-β”‚ β”œβ”€β”€ layout.tsx # Root layout
-β”‚ └── page.tsx # Home page
-β”œβ”€β”€ components/ # React components
-β”‚ β”œβ”€β”€ ui/ # Reusable UI components
-β”‚ β”œβ”€β”€ calendar-*.tsx # Calendar components
-β”‚ β”œβ”€β”€ preset-*.tsx # Preset components
-β”‚ └── shift-*.tsx # Shift components
-β”œβ”€β”€ lib/ # Utility functions
-β”‚ β”œβ”€β”€ db/ # Database configuration
-β”‚ β”‚ β”œβ”€β”€ index.ts # Database client
-β”‚ β”‚ └── schema.ts # Drizzle schema
-β”‚ β”œβ”€β”€ date-utils.ts # Date helper functions
-β”‚ β”œβ”€β”€ types.ts # TypeScript types
-β”‚ └── utils.ts # General utilities
-β”œβ”€β”€ data/ # SQLite database directory
-β”œβ”€β”€ drizzle/ # Database migrations
-β”œβ”€β”€ docker-compose.yml # Docker configuration
-└── Dockerfile # Docker image definition
-```
-
-## API Endpoints
-
-### Calendars
-
-- `GET /api/calendars` - List all calendars
-- `POST /api/calendars` - Create a new calendar
-- `GET /api/calendars/[id]` - Get calendar by ID
-- `PUT /api/calendars/[id]` - Update calendar
-- `DELETE /api/calendars/[id]` - Delete calendar
-
-### Shifts
-
-- `GET /api/shifts?calendarId=<id>&startDate=<date>&endDate=<date>` - List shifts
-- `POST /api/shifts` - Create a new shift
-- `GET /api/shifts/[id]` - Get shift by ID
-- `PUT /api/shifts/[id]` - Update shift
-- `DELETE /api/shifts/[id]` - Delete shift
-
-### Presets
-
-- `GET /api/presets?calendarId=<id>` - List presets
-- `POST /api/presets` - Create a new preset
-- `GET /api/presets/[id]` - Get preset by ID
-- `PUT /api/presets/[id]` - Update preset
-- `DELETE /api/presets/[id]` - Delete preset
-
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.