documentation added

LICENSE

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2024 hyperoot.dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,51 @@
-# Cheatsheetify
+<h1 align="center">Cheatsheetify</h1>
+
+<p align="center">
+<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/cheatsheetify?style=for-the-badge&labelColor=%23363a4f&color=%23f5a97f&link=https%3A%2F%2Fpypi.org%2Fproject%2Fcheatsheetify%2F">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/HYP3R00T/Cheatsheetify/pypi_publish.yml?style=for-the-badge&labelColor=%23363a4f&color=%238aadf4">
+</p>
+
+cheatsheetify is a command-line tool that generates PDF versions of cheatsheets for popular command-line tools.
+
+Documentation: [cheatsheetify.hyperoot.dev](https://cheatsheetify.hyperoot.dev/)
+
+## Features
+
+- Generates PDF cheatsheets for popular command-line tools.
+- Easy to use with a simple command-line interface.
+- Customizable output options.
+- Custom themes for the PDFs
+
+## Installation
+
+To install cheatsheetify, you can use pip:
+
+```sh
+pip install cheatsheetify
+```
+
+## Usage
+
+```sh
+python cheatsheetify <list of commands>
+```
+
+For example, to generate a cheatsheet for `ls cp rm`, you would run:
+
+```sh
+python cheatsheetify ls cp rm
+```
+
+The generated PDF cheatsheet will be saved in the current directory. Read the [documentation](https://cheatsheetify.hyperoot.dev/) to learn more about the avialable customizations.
+
+## Credits
+
+This project would not have been possible without the awesome [tldr](https://tldr.sh/) project.
+
+## Contributing
+
+Contributions are welcome! If you'd like to add support for a new command-line tool or improve an existing cheatsheet, feel free to open a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

docs/index.md

@@ -1,3 +1,97 @@
-# Welcome to Cheatsheetify
+---
+hide:
+- navigation
+---
 
-pypi: https://pypi.org/project/cheatsheetify/
+<h1 align="center">Cheatsheetify</h1>
+
+<p align="center">
+<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/cheatsheetify?style=for-the-badge&labelColor=%23363a4f&color=%23f5a97f&link=https%3A%2F%2Fpypi.org%2Fproject%2Fcheatsheetify%2F">
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/HYP3R00T/Cheatsheetify/pypi_publish.yml?style=for-the-badge&labelColor=%23363a4f&color=%238aadf4">
+</p>
+
+cheatsheetify is a command-line tool that generates PDF versions of cheatsheets for popular command-line tools.
+
+## Installation
+
+<!-- termynal -->
+```sh
+pip install cheatsheetify
+---> 100%
+```
+
+## Usage
+
+### Basic
+
+```sh
+python cheatsheetify [commands]
+```
+
+For example, to generate a cheatsheet for `ls`, you would run:
+
+```sh
+python cheatsheetify ls
+```
+
+### Cheatsheet of multiple commands
+
+We also have the option where you can pass a list of commands and we will generated a single PDF for all the cheatsheets of the commands.
+
+```sh
+python cheatsheetify ls cp rm
+```
+
+### Custom title
+
+The title of the generated PDF can be changed using the `--title` flag.
+
+```sh
+python cheatsheetify ls --title "My cheatsheets"
+```
+
+### Custom PDF filename
+
+The filename of the generated PDF can be changed using the `--filename` flag.
+
+```sh
+python cheatsheetify ls --filename "BestCheatsheet"
+```
+
+This example will generated the PDF as `BestCheatsheet.pdf`
+
+### Custom theme
+
+You can select the color scheme of the PDF from the available themes. You can use `--theme` flag to change the theme. The default theme is based on Catppuccin (Macchiato) theme.
+
+```sh
+python cheatsheetify ls --theme Nord
+```
+
+### Remove credit 😟
+
+When the PDF is generated, right below the title, there is a link to this project. If you want to remove that, you can simply use `--no-credits` flag.
+
+```sh
+python cheatsheetify ls --no-credits
+```
+
+### CLI help
+
+To show the help page, just use the `--help` flag.
+
+```sh
+python cheatsheetify --help
+```
+
+## Credits
+
+This project would not have been possible without the awesome [tldr](https://tldr.sh/) project.
+
+## Contributing
+
+Contributions are welcome! If you'd like to add support for a new feature or themes, feel free to open a pull request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

mkdocs.yml

@@ -7,13 +7,15 @@ theme:
     logo: material/graph
   name: "material"
   palette:
-    - scheme: default
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
       accent: teal
       primary: black
       toggle:
         icon: material/toggle-switch
         name: Switch to dark mode
-    - scheme: slate
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
       accent: teal
       primary: black
       toggle:
@@ -26,7 +28,7 @@ theme:
     - navigation.instant
     - navigation.instant.progress
     - navigation.tracking
-    - navigation.tabs
+    # - navigation.tabs
     - navigation.path
     - navigation.indexes
     - navigation.top
@@ -81,6 +83,4 @@ extra:
       link: https://github.com/HYP3R00T
     - icon: fontawesome/brands/linkedin
       link: https://www.linkedin.com/in/rajesh-kumar-das/
-    - icon: fontawesome/brands/x-twitter
-      link: https://twitter.com/HYP3R00T
-# copyright: Copyright © 2024 hyperoot.dev
+copyright: Copyright © 2024 hyperoot.dev

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "cheatsheetify"
-version = "0.1.1"
-description = ""
+version = "0.1.2"
+description = "cheatsheetify is a command-line tool that generates PDF versions of cheatsheets for popular command-line tools"
 authors = ["HYP3R00T <[email protected]>"]
 license = "MIT"
 readme = "README.md"