chore: update dependency requirements and documentation setup

- Updated requirements.txt to reflect changes in dependencies.
- Installed all necessary dependencies, including development dependencies.
- Implemented documentation using MkDocs with the Material theme for comprehensive project documentation.

docs/acknowledgement.md

@@ -0,0 +1,8 @@
+This project has been heavily borrowed and improved upon the work by [Adam Tal](https://github.com/AdmTal/crowdcast).
+
+## Music
+
+- Music by <a href="https://pixabay.com/users/top-flow-production-28521292/?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=172471">Sergio Prosvirini</a> from <a href="https://pixabay.com/music//?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=172471">Pixabay</a>
+- Music by <a href="https://pixabay.com/users/bodleasons-28047609/?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=159456">Bohdan Kuzmin</a> from <a href="https://pixabay.com//?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=159456">Pixabay</a>
+- Music by <a href="https://pixabay.com/users/lesfm-22579021/?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=161191">Oleksii Kaplunskyi</a> from <a href="https://pixabay.com/music//?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=161191">Pixabay</a>
+- Music by <a href="https://pixabay.com/users/musicbyscandinavianz-35973063/?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=173689">Oliver Moilanen</a> from <a href="https://pixabay.com//?utm_source=link-attribution&utm_medium=referral&utm_campaign=music&utm_content=173689">Pixabay</a>

docs/development.md

@@ -0,0 +1,19 @@
+# Pointers for Developers
+
+## How to start
+
+- If you want to develop in a local environment, simply clone the repo `git clone https://github.com/rajtilakjee/kyms.git` and start developing.
+- If you want to develop on a Gitpod, click on the following link:
+
+    [Open in Gitpod](https://gitpod.io/#https://github.com/rajtilakjee/kyms-cli)
+
+## Dependencies
+
+- All the dependencies for the library are given in the `requirements.txt` files. You can use `pip -r install requirements.txt` to install the dependencies.
+
+## Dev Dependencies
+
+There are only 2 dev dependencies as of now:
+
+- black
+- ruff

docs/index.md

@@ -0,0 +1,49 @@
+<div align='center'>
+    <h1>
+        <b>KeepYourMouthShut</b>
+    </h1>
+    <h3>
+        Acid Reflux for your Ears!
+    <h3>
+</div>
+
+![GitHub commit activity (branch)](https://img.shields.io/github/commit-activity/t/rajtilakjee/keepyourmouthshut) . ![Netlify](https://img.shields.io/netlify/b1b62d2d-3ac1-4559-a94c-445226a2baa1) . ![GitHub](https://img.shields.io/github/license/rajtilakjee/keepyourmouthshut) . ![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.keepyourmouthshut.net%2F) . ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/rajtilakjee/keepyourmouthshut) . ![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/rajtilakjee)
+
+Calm down! KeepYourMouthShut is a Python app that provides an AI-assisted 360-degree solution to all your Podcast requirements. From writing the scripts to providing an unique voice, kyms has the ability to produce an entire episode for your Podcast all by itself. Here are a few features of KYMS CLI:
+
+- **Smart Script Creation** – Effortlessly generate captivating podcast scripts using advanced Al algorithms, from content structure to engaging narratives.
+- **Dynamic Voice Synthesis** – Infuse life into your podcasts with natural voice synthesis, choosing from a variety of professional-grade voices.
+- **Continuous Enhancement** – Benefit from ongoing updates and refinements that leverage user feedback and emerging technologies.
+- **Ad Integration and Monetization** – Seamless integration of advertisements into your podcast episodes while maintaining a listener-friendly experience.
+- **Comprehensive Support** – Customer support for troubleshooting, and technical assistance, ensuring a smooth podcasting experience.
+- **Cutting-Edge Tech Utilization** – Harness the latest advancements in Al and speech synthesis technology to elevate your podcast production.
+
+## Tech Stack
+
+- elevenlabs
+- pydub
+- PyYAML
+- openai
+- streamlit
+
+## Sample show created with kyms
+
+- [Listenology on Spotify](https://open.spotify.com/show/4NSKdBlpOuet1YkSoyXJSN?si=95a6075c26f54860)
+- [Listenology on Spotify for Podcasters](https://podcasters.spotify.com/pod/show/listenology)
+- [Listenology on Apple Podcasts](https://podcasts.apple.com/us/podcast/listenology/id1697707441)
+
+## Citation
+
+If you work upon this library of with this library, please refer to it as follows:
+
+```
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Bhattacharjee"
+  given-names: "Rajtilak"
+title: "keepyourmouthshut"
+version: 1.0.0
+date-released: 2023-11-10
+url: "https://github.com/rajtilakjee/keepyourmouthshut"
+```

docs/resources.md

@@ -0,0 +1,6 @@
+## Useful links
+
+- Website: [https://www.keepyourmouthshut.net/](https://www.keepyourmouthshut.net/)
+- GitHub repo: [https://github.com/rajtilakjee/kyms](https://github.com/rajtilakjee/kyms-cli)
+- PyPi: [https://pypi.org/project/kyms/](https://pypi.org/project/kyms-cli/)
+- Reddit: [https://www.reddit.com/r/KeepYourMouthShut/](https://www.reddit.com/r/KeepYourMouthShut/)

docs/usage.md

@@ -0,0 +1,17 @@
+# How to install KYMS CLI
+
+## Using pip
+
+The simples way to install kyms is using the following command:
+
+```
+pip install kyms-cli
+```
+
+## How to use
+
+Once install, use the following command to generate a complete podcast episode:
+
+```
+kyms-cli gencast
+```

mkdocs.yml

@@ -0,0 +1,62 @@
+site_name: KeepYourMouthShut
+site_description: Acid Reflux for your Ears!
+site_author: Rajtilak Bhattacharjee
+site_url: https://www.keepyourmouthshut.net
+
+repo_url: https://github.com/rajtilakjee/keepyourmouthshut
+repo_name: keepyourmouthshut
+theme:
+  name: material
+  palette:
+    # Palette toggle for light mode
+    - scheme: default
+      primary: deep purple
+      toggle:
+        icon: material/weather-night
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      primary: deep purple
+      toggle:
+        icon: material/weather-sunny
+        name: Switch to light mode
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - search.suggest
+    - search.highlight
+    - search.share
+    - navigation.top
+    - navigation.footer
+    - navigation.tabs
+    - navigation.tabs.sticky
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/rajtilakjee
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/rajtilakjee
+    - icon: fontawesome/brands/linkedin
+      link: https://www.linkedin.com/in/rajtilak/
+    - icon: fontawesome/brands/discord
+      link: https://discordapp.com/users/969666251536347146
+
+plugins:
+  - search:
+      lang: en
+
+markdown_extensions:
+  - attr_list
+  - md_in_html
+
+copyright: >-
+  Copyright © 2023 Rajtilak Bhattacharjee
+
+nav:
+  - Home: index.md
+  - Usage: usage.md
+  - Development: development.md
+  - Resources: resources.md
+  - Acknowledgement: acknowledgement.md

requirements.txt

@@ -1,6 +1,5 @@
-typer[all]
 elevenlabs
 pydub
-pyyaml
+PyYAML
 openai
 streamlit