docs: update README

x-pt · Aug 13, 2024 · a6b52b3 · a6b52b3
1 parent ea06dee
commit a6b52b3
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 45 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -2,41 +2,41 @@
 name: Github Pages
 
 on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
+    # Runs on pushes targeting the default branch
+    push:
+        branches: [ "main" ]
 
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
-  contents: read
-  pages: write
-  id-token: write
+    contents: read
+    pages: write
+    id-token: write
 
 # Allow one concurrent deployment
 concurrency:
-  group: "pages"
-  cancel-in-progress: true
+    group: "pages"
+    cancel-in-progress: true
 
 jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Setup Pages
-        uses: actions/configure-pages@v2
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
-        with:
-          # Upload entire repository
-          path: '.'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v1
+    # Single deploy job since we're just deploying
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v4
+            -   name: Setup Pages
+                uses: actions/configure-pages@v5
+            -   name: Upload artifact
+                uses: actions/upload-pages-artifact@v3
+                with:
+                    # Upload entire repository
+                    path: '.'
+            -   name: Deploy to GitHub Pages
+                id: deployment
+                uses: actions/deploy-pages@v4
diff --git a/README.md b/README.md
@@ -2,23 +2,16 @@
 
 [![CI](https://github.com/x-pt/x-pt.github.io/actions/workflows/pages.yml/badge.svg)](https://github.com/x-pt/x-pt.github.io/actions)
 
-A template to create an awesome project hosted on GitHub in no time.
+A streamlined template for quickly setting up projects on GitHub.
 
-## Usage
+## Quick Start
 
-```shell
-cargo generate --git https://github.com/x-pt/template.git template/cxx
+```bash
+# Generate a project template dynamically
+cookiecutter gh:x-pt/template
 
-# or
-cargo generate gh:x-pt/template template/cxx
-
-# or just
-cargo generate x-pt/template template/cxx
-```
-
-## Support Cxx, Go, Python
-
-```shell
-cargo generate gh:x-pt/template template/go
-cargo generate gh:x-pt/template template/py
+# Generate a specific language template
+cookiecutter gh:x-pt/template --directory template/cxx  # C++
+cookiecutter gh:x-pt/template --directory template/go   # Go
+cookiecutter gh:x-pt/template --directory template/py   # Python
 ```