Add README.md with project documentation
This commit is contained in:
parent
e78181c9f7
commit
b542f13f21
30
README.md
30
README.md
@ -0,0 +1,30 @@
|
|||||||
|
# MovieMapper
|
||||||
|
|
||||||
|
A desktop application for organizing and managing movie and TV show collections.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Browse and scan directories for media files
|
||||||
|
- Search TV shows using TheTVDB API
|
||||||
|
- View show details, seasons, and episodes
|
||||||
|
- Rename files by clicking on the file name
|
||||||
|
- Display video durations in mm:ss format
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
1. Clone the repository
|
||||||
|
2. Install dependencies: `npm install`
|
||||||
|
3. Run the application: `npm start` or `electron .`
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
- Electron
|
||||||
|
- fluent-ffmpeg (for video duration detection)
|
||||||
|
- TheTVDB API integration
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
1. Click "Select Directory" to choose a folder containing media files
|
||||||
|
2. The application will scan the directory and display media files with their durations
|
||||||
|
3. Click on any file name to rename it
|
||||||
|
4. Use the search functionality to find TV shows and their details
|
||||||
Loading…
x
Reference in New Issue
Block a user