Merge pull request #5 from deven367/docs

Docs

.github/workflows/docs.yml

@@ -0,0 +1,29 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

README.md

@@ -7,20 +7,21 @@ This is a very simple utility script that I just created so that you could send
 To install the app, you just need to do,
 
 ```sh
+pip install talk-to-a-file
+
+# or
+
 pip install git+https://github.com/deven367/talk-to-a-file
 ```
 
-or
+If you wish to develop/contribute to the project,
 
 ```sh
 git clone https://github.com/deven367/talk-to-a-file
 cd talk-to-a-file
 pip install -e .
 ```
 
-> [!NOTE]
-> The package will be uploaded on `pypi` soon.
-
 ### prerequisites
 
 To use this package, you need to use your own `ANTHROPIC_API_KEY`. Before using the CLI command, you need to set the environment variable. To do so,

docs/index.md

@@ -0,0 +1,3 @@
+# Welcome to talk-to-a-file
+
+This is the homepage of the documentation.

mkdocs.yml

@@ -0,0 +1,9 @@
+site_name: talk-to-a-file
+theme:
+  name: material
+  search: true
+  features:
+    - quick-links
+    - navigation
+    - search
+    - toc

pyproject.toml

@@ -27,6 +27,7 @@ build-backend = "setuptools.build_meta"
 talk-to-a-pdf = "ttp.talk:main"
 
 [project.optional-dependencies]
-test = [
-  "pytest"
+dev = [
+  "pytest",
+  "mkdocs-material==9.4.8"
 ]