- A self-hosted tool to download latest podcast episodes as soon as they become live
+ A self-hosted podcast manager to download episodes as soon as they become live
Explore the docs ยป
@@ -60,15 +60,26 @@
## Table of Contents
* [About the Project](#about-the-project)
+ * [Motivation](#motivation)
* [Built With](#built-with)
* [Installation](#installation)
* [License](#license)
+* [Roadmap](#roadmap)
* [Contact](#contact)
## About The Project
+Podgrab is a is a self-hosted podcast manager which automatically downloads latest podcast episodes. It is a light-weight application built using GO.
+
+It works best if you already know which podcasts you want to monitor. However there is an experimental podcast search system powered by iTunes built into Podgrab
+
+### Motivation
+
+Podgrab started a tool that I initially built to solve a specific problem I had. During the COVID pandemic times I started going for a run. I do not prefer taking by phone along so I would add podcast episodes to my smart watch which could be connected with my bluetooth earphones. Most podcasting apps do not expose the mp3 files directly which is why I decided to build this quick tool for myself. Once it reached a stage where my requirements were fulfilled I decided to make it a little pretty and share it with everyone else.
+
+
![Product Name Screen Shot][product-screenshot]
@@ -79,10 +90,9 @@
* [GORM](https://github.com/go-gorm/gorm)
* [SQLite](https://www.sqlite.org/index.html)
-
## Installation
-The easiest way to run Podgrab is to run it as a container.
+The easiest way to run Podgrab is to run it as a docker container.
### Using Docker
@@ -98,7 +108,7 @@ Binding local volumes to the container
### Using Docker-Compose
-Modify the docker compose file provided [here]() to update the volume and port binding and run the following command
+Modify the docker compose file provided [here](https://github.com/akhilrex/podgrab/blob/master/docker-compose.yml) to update the volume and port binding and run the following command
```yaml
version: "2.1"
services:
@@ -125,7 +135,11 @@ services:
Distributed under the MIT License. See `LICENSE` for more information.
-
+## Roadmap
+Following are the things that I plan to complete in the near future.
+- Some more code refactoring.
+- API standardisation so that it can be used to build apps on top of it.
+- Better search and discovery
## Contact
diff --git a/images/screenshot.jpg b/images/screenshot.jpg
index 897b3a3..a97f86d 100644
Binary files a/images/screenshot.jpg and b/images/screenshot.jpg differ