Merge branch 'main' of https://github.com/teddante/SubtitleSplitter

README.md

@@ -1,2 +1,54 @@
 # SubtitleSplitter
-A utility that automatically converts plain text documents into timed subtitle files. It intelligently splits text into two-sentence subtitle frames, timing each based on average reading speed to enhance viewer comprehension. Ideal for creating captions, transcripts, and subtitles for various multimedia applications.
+
+SubtitleSplitter is a simple command-line tool written in C# that allows you to convert a plain text file into a series of subtitles in `.srt` format. It's designed to take a text file containing a script or transcript and break it into chunks that can be used as subtitles for video or audio content.
+
+## Features
+
+- Read a text file and split it into sentences.
+- Convert sentences into a subtitle file format.
+- Customize the number of sentences per subtitle.
+- Customize the gap duration between subtitles.
+
+## Getting Started
+
+### Prerequisites
+
+- .NET SDK
+
+### Installation
+
+Clone the repository to your local machine using:
+
+```bash
+git clone https://github.com/yourusername/SubtitleSplitter.git
+```
+
+Navigate into the cloned repository:
+
+```bash
+cd SubtitleSplitter
+```
+
+Build the project using:
+
+```bash
+dotnet build
+```
+
+### Usage
+
+To use SubtitleSplitter, simply drag a `.txt` file onto the executable or run it from the command line with the file path as an argument.
+
+```bash
+SubtitleSplitter.exe "path/to/your/file.txt"
+```
+
+The tool will then generate an `.srt` file in the same directory as the input file.
+
+## Contributing
+
+If you would like to contribute to the development of SubtitleSplitter, please fork the repository and submit a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE.md file for details.