move to normal markdown file

github seems to be struggling to render the .rst file and I don't see a reason to keep it that way when pypi is compatible with both: https://github.com/fauna/fauna-python
fauna · Mar 26, 2024 · cbbfcf2 · cbbfcf2
1 parent 727efe7
commit cbbfcf2
Show file tree

Hide file tree

Showing 3 changed files with 170 additions and 205 deletions.
diff --git a/.github/workflows/validate-readme.yml b/.github/workflows/validate-readme.yml
@@ -2,7 +2,7 @@ name: Validate README
 on:
   push:
     paths:
-      - 'README.rst'
+      - 'README.md'
 
 jobs:
   validate:
@@ -19,5 +19,5 @@ jobs:
       - name: Install dependencies
         run: pip install readme_renderer 'readme_renderer[md]'
 
-      - name: Validate readme.rst
-        run: python -m readme_renderer README.rst
+      - name: Validate README.md
+        run: python -m readme_renderer README.md