diff --git a/.github/workflows/snake_animation.yml b/.github/workflows/snake_animation.yml deleted file mode 100644 index 2309a6c..0000000 --- a/.github/workflows/snake_animation.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: Generate snake animation - -on: - schedule: - - cron: "* */12 * * *" - - workflow_dispatch: - - push: - branches: - - main - -jobs: - generate: - permissions: - contents: write - runs-on: ubuntu-latest - timeout-minutes: 5 - - steps: - - name: generate snake.svg - uses: Platane/snk/svg-only@v3 - with: - github_user_name: ${{ github.repository_owner }} - outputs: dist/snake.svg?palette=github-dark - - - name: push snake.svg to the output branch - uses: crazy-max/ghaction-github-pages@v3.1.0 - with: - target_branch: output - build_dir: dist - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index a5e07e6..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2026 Dario Vargas - -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. \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index b95c29a..0000000 --- a/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# 🐍 Snake Animation - -Automated GitHub contribution snake animation, generated with GitHub Actions and published as an SVG. - -## 👀 Preview - -![Snake Animation](https://github.com/jkdevcode/snake_animation/raw/output/snake.svg) - -## ✨ Features - -- Fully automated SVG generation -- Scheduled updates every 12 hours -- Clean output published to the `output` branch -- Lightweight and easy to maintain - -## 🛠️ Technologies - -- [Platane/snk/svg-only@v3](https://github.com/Platane/snk) -- [crazy-max/ghaction-github-pages@v3.1.0](https://github.com/crazy-max/ghaction-github-pages) -- GitHub Actions -- SVG output - -## ⚙️ How It Works - -1. GitHub Actions runs on a schedule, on push to `main`, or manually. -2. `Platane/snk/svg-only@v3` generates the snake animation as `snake.svg`. -3. `crazy-max/ghaction-github-pages@v3.1.0` publishes the file to the `output` branch. -4. The README embeds the SVG directly from that branch. - -## 📚 What I Learned - -- How to automate visual assets with GitHub Actions -- How to publish generated files through a dedicated branch -- How to keep a project README simple, useful, and polished - -## 🎯 Motivation - -This project serves as a compact portfolio piece showing how automation can turn GitHub contribution data into a clean visual identity. diff --git a/snake.svg b/snake.svg new file mode 100644 index 0000000..5e2e8eb --- /dev/null +++ b/snake.svg @@ -0,0 +1 @@ +Generated with https://github.com/Platane/snk \ No newline at end of file