Merge pull request #1 from Fazzani/Fazzani-patch-1

Rename docker-compse.yml to docker-compose.yml

README.md

@@ -54,41 +54,23 @@
 Proxarr is a lightweight proxy server for automatically qualify requested media items based in countries served by watching providers.
 It uses TMDB to find out which streaming services are available in the selected region.
 
+<img src="images/workflow.gif">
+
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- GETTING STARTED -->
 ## Getting Started
 
-### Prerequisites
-
-* Acquire TMDB API KEY
-  [How](https://dev.to/codexive_zech/streamlining-your-contribution-how-to-get-your-tmdb-api-key-for-ldbflix-contribution-52gf#:~:text=How%20to%20Obtain%20a%20TMDB%20API%20Key)
-* Obtain SONARR/RADARR API KEY<br/>
-  <img src="images/arr_api_key.png" width="230">
-
-### Installation
-
-1. Clone the repo
-   ```sh
-   git clone https://github.com/Fazzani/Proxarr.git
-   ```
-
-2. Update your [config.yml](./src/Proxarr.Api/config.yml) with your API keys according to your setup
-   ```yaml
-    AppConfiguration:
-        TMDB_API_KEY: "{{ TMDB API KEY}}"
-        TAG_NAME: "q"
-        WATCH_PROVIDERS: "YOUR PROVIDERS HERE seperated by comma (ex: FR:Netflix,US:Amazon Prime Video)"
-        Clients: # Add as many clients as you want
-        - ApiKey: "{{ SONAR OR RADARR API KEY }}"
-          BaseUrl: "{{ SONARR OR RADARR BASE URL }}"
-   ``` 
-   
-3. Run the application
-   ```sh
-   dotnet run ./src/Proxarr.Api/Proxarr.Api.csproj
-   ```
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
+1. Acquire TMDB API KEY
+   [How](https://dev.to/codexive_zech/streamlining-your-contribution-how-to-get-your-tmdb-api-key-for-ldbflix-contribution-52gf#:~:text=How%20to%20Obtain%20a%20TMDB%20API%20Key)
+2. Obtain SONARR/RADARR API KEY<br/>
+   <img src="images/arr_api_key.png" width="250" />
+3. Prepare your [config.yml](./src/Proxarr.Api/config.yml) with your configuration
+4. From Sonarr/Radarr you create a new Webhook connection to Proxarr server
+   <img src="images/webhook_creation.png" width="250" />
+5. `Application URL` field must be specified this will enable Proxarr to determine the correct api key to use when sending the response to Sonarr/Radarr
+   <img src="images/appli_url_config.png" width="250" />
+6. Enjoy!
 
 <!-- USAGE EXAMPLES -->
 ## Usage
@@ -142,6 +124,44 @@ Don't forget to give the project a star! Thanks again!
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
+### Development
+
+Before the project can be built, you must first install the .NET 9.0 SDK on your system.
+
+Instructions to run this project from the command line are included here, but you will also need to install an IDE if you want to debug Proxarr while it is running.
+
+### Prerequisites
+
+* Acquire TMDB API KEY
+  [How](https://dev.to/codexive_zech/streamlining-your-contribution-how-to-get-your-tmdb-api-key-for-ldbflix-contribution-52gf#:~:text=How%20to%20Obtain%20a%20TMDB%20API%20Key)
+* Obtain SONARR/RADARR API KEY<br/>
+  <img src="images/arr_api_key.png" width="230">
+
+### Installation
+
+1. Clone the repo
+   ```sh
+   git clone https://github.com/Fazzani/Proxarr.git
+   cd ./Proxarr
+   ```
+
+2. Update your [config.yml](./src/Proxarr.Api/config.yml) with your API keys according to your setup
+   ```yaml
+    AppConfiguration:
+        TMDB_API_KEY: "{{ TMDB API KEY}}"
+        TAG_NAME: "q"
+        WATCH_PROVIDERS: "YOUR PROVIDERS HERE seperated by comma (ex: FR:Netflix,US:Amazon Prime Video)"
+        Clients: # Add as many clients as you want
+        - ApiKey: "{{ SONAR OR RADARR API KEY }}"
+          BaseUrl: "{{ SONARR OR RADARR BASE URL }}"
+   ``` 
+   
+3. Run the application
+   ```sh
+   dotnet run ./src/Proxarr.Api/Proxarr.Api.csproj
+   ```
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 ### Top contributors:
 
 <a href="https://github.com/Fazzani/Proxarr/graphs/contributors">
@@ -178,3 +198,4 @@ Project Link: [https://github.com/Fazzani/Proxarr](https://github.com/Fazzani/Pr
 [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
 [linkedin-url]: https://www.linkedin.com/in/heni-fazzani
 [arr-api-key]: images/arr_api_key.png
+[workflow]: images/workflow.gif

src/Proxarr.sln

@@ -13,7 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 	ProjectSection(SolutionItems) = preProject
 		..\.dockerignore = ..\.dockerignore
 		..\.gitignore = ..\.gitignore
-		..\docker-compse.yml = ..\docker-compse.yml
+		..\docker-compose.yml = ..\docker-compose.yml
 		..\.github\workflows\docker-image.yml = ..\.github\workflows\docker-image.yml
 		..\Dockerfile = ..\Dockerfile
 		..\README.md = ..\README.md