Update GitHub readme with usage instructions (#9)

* Update README.md

* Update README.md

README.md

@@ -1,2 +1,53 @@
-# mov2gif
- Convert .mov to .gif via simple Web UI
+<div align="center">
+
+<h1>mov2gif</h1>
+
+<p align="center">
+<a href="https://mov2gif.lanedirt.com">Live demo 🔥</a> • <a href="#installation">Installation ⚙️</a>
+</p>
+
+<h3 align="center">
+Convert .mov to .gif using a simple web UI
+</h3>
+
+[<img src="https://img.shields.io/github/actions/workflow/status/lanedirt/mov2gif/dotnet-integration-tests.yml?label=integration tests">](https://github.com/lanedirt/mov2gif/actions/workflows/dotnet-integration-tests.yml)
+
+</div>
+
+mov2gif is an open-source .mov to .gif converter built with C# ASP.NET technology. It provides a simple web interface to convert your .mov files to .gif format with customizable settings like quality, frame rate, and resolution.
+
+## Live demo
+![mov2gif_Screen Recording 2024-11-24 at 18 24 12](https://github.com/user-attachments/assets/5f2212cf-b55d-4105-a6f5-703c739b2da8)
+
+(This .gif is made with this tool)
+
+You can try out the app yourself at [mov2gif.lanedirt.com](https://mov2gif.lanedirt.com)
+
+## Installation
+
+The easiest way to run mov2gif is using Docker. You can run it on your local machine or deploy it to a server. The container includes all required dependencies (including FFmpeg). No extra installations or plugins required.
+
+```bash
+docker run -d -p 3100:80 ghcr.io/lanedirt/mov2gif:latest
+```
+
+After running the container, the web UI will be available at:
+- http://localhost:3100
+
+## Contributing
+
+Contributions are welcome! Feel free to submit a Pull Request.
+
+## Tech stack / credits
+The following technologies, frameworks and libraries are used in this project:
+
+- [C#](https://docs.microsoft.com/en-us/dotnet/csharp/) - A simple, modern, object-oriented, and type-safe programming language.
+- [ASP.NET Core](https://dotnet.microsoft.com/apps/aspnet) - An open-source framework for building modern, cloud-based, internet-connected applications.
+- [Blazor Server](https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor) - A framework for building interactive web UIs using C#.
+- [FFmpeg](https://ffmpeg.org/) - A complete, cross-platform solution to record, convert and stream audio and video.
+- [Docker](https://www.docker.com/) - A platform for building, sharing, and running containerized applications.
+- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework for rapidly building custom designs.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

src/Mov2Gif.Client/Dockerfile

@@ -19,6 +19,8 @@ RUN dotnet publish "Mov2Gif.Client/Mov2Gif.Client.csproj" -c Release -o /app/pub
 FROM mcr.microsoft.com/dotnet/aspnet:9.0 AS final
 WORKDIR /app
 
+# Install FFmpeg. This is also done in the Mov2Gif.IntegrationTests Dockerfile.
+# When changing this, also make sure to update the Dockerfile in the integration tests project.
 RUN apt-get update && \
     apt-get install -y ffmpeg && \
     rm -rf /var/lib/apt/lists/*

src/Tests/Mov2Gif.IntegrationTests/Dockerfile

@@ -10,7 +10,8 @@ RUN dotnet restore "Tests/Mov2Gif.IntegrationTests/Mov2Gif.IntegrationTests.cspr
 COPY ["src/Tests/Mov2Gif.IntegrationTests/", "Tests/Mov2Gif.IntegrationTests/"]
 COPY ["src/Utilities/Mov2Gif.Utilities.GifConverter/", "Utilities/Mov2Gif.Utilities.GifConverter/"]
 
-# Install FFmpeg
+# Install FFmpeg. This is also done in the Mov2Gif.Client Dockerfile.
+# When changing this, also make sure to update the Dockerfile in the client project.
 RUN apt-get update && \
     apt-get install -y ffmpeg && \
     rm -rf /var/lib/apt/lists/*