Update README.md

README.md

@@ -8,7 +8,7 @@
 
 This GitHub Action creates a GitHub contribution calendar on a 3D profile image.
 
-## How to use (GitHub Actions)
+## How to use (GitHub Actions) - Basic
 
 This action generate your github profile 3d contribute calendar and make a commit to your repo.
 You can also trigger action by yourself after add this action.
@@ -130,6 +130,10 @@ e.g.
 ![](./profile-3d-contrib/profile-green-animate.svg)
 ```
 
+## How to use (GitHub Actions) - Advanced examples
+
+#### [More info in EXAMPLES.md](./EXAMPLES.md)
+
 ## How to use (local)
 
 Set the `GITHUB_TOKEN` environment variable to the value of "personal access token".
@@ -151,106 +155,6 @@ npm run build
 node . USER_NAME
 ```
 
-## Advanced example: automatic day/night switching + keeping output in other branch
-
-This alternative workflow generates two files, `day.svg` and `night.svg`, and pushes it to `output-3d-contrib` branch, keeping the main repo 'clean' from build artifacts.
-
-### step 1. Create special repository ([see above](#step-1-create-special-repository))
-### step 2. Create `conf/github-profile-3d-contrib.json` file in your <username> repo:
-```json:conf/github-profile-3d-contrib.json
-[
-    {
-        "type": "normal",
-        "fileName": "day.svg",
-        "backgroundColor": "#ffffff",
-        "foregroundColor": "#00000f",
-        "strongColor": "#111133",
-        "weakColor": "gray",
-        "radarColor": "#47a042",
-        "growingAnimation": true,
-        "contribColors": [
-            "#efefef",
-            "#d8e887",
-            "#8cc569",
-            "#47a042",
-            "#1d6a23"
-        ]
-    },
-    {
-        "type": "rainbow",
-        "fileName": "night.svg",
-        "backgroundColor": "#00000f",
-        "foregroundColor": "#eeeeff",
-        "strongColor": "rgb(255,200,55)",
-        "weakColor": "#aaaaaa",
-        "radarColor": "rgb(255,200,55)",
-        "growingAnimation": true,
-        "saturation": "50%",
-        "contribLightness": [
-            "20%",
-            "30%",
-            "35%",
-            "40%",
-            "50%"
-        ],
-        "duration": "10s",
-        "hueRatio": -7
-    }
-]
-```
-
-### step 3. Create `.github/workflows/profile-3d-contrib.yml` workflow file in your <username> repo:
-```yaml:.github/workflows/profile-3d-contrib.yml
-name: generate 3d chart for profile contributions
-
-on:
-  # run automatically every 24 hours
-  schedule:
-    - cron: "0 */24 * * *" 
-  
-  # allows to manually run the job at any time
-  workflow_dispatch:
-  
-  # run on every push on the main branch
-  # don't forget to change if you're using 'master' branch
-  push:
-    branches:
-    - main
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: generate-github-profile-3d-contrib
-    steps:
-      - uses: actions/checkout@v3
-      - uses: yoshi389111/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          USERNAME: ${{ github.repository_owner }}
-          SETTING_JSON: conf/github-profile-3d-contrib.json
-          
-      # push the content of <build_dir> to a branch
-      # the content will be available at https://raw.githubusercontent.com/<github_user>/<repository>/<target_branch>/<file> , or as github page
-      - name: push SVGs to the output-3d branch
-        uses: crazy-max/[email protected]
-        with:
-          target_branch: output-3d-contrib
-          build_dir: profile-3d-contrib
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-
-### step 4. Edit `README.md` in your <username> repo, adding the following code:
-Do not forget to replace `<github_user>` and `<repository>` with your GitHub username.
-```html
-<p align="center" >
-	<picture>
-	  <source media="(prefers-color-scheme: dark)"  srcset="https://raw.githubusercontent.com/<github_user>/<repository>/output-3d-contrib/night.svg" />
-	  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/<github_user>/<repository>/output-3d-contrib/day.svg" />
-	  <img alt="github profile contributions chart"    src="https://raw.githubusercontent.com/<github_user>/<repository>/output-3d-contrib/day.svg" />
-	</picture>
-</p>
-```
 
 ## Licence