diff --git a/README.md b/README.md index 7eee805..ee3f98f 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,20 @@ A GitHub Action to deploy your static site to GitHub Pages with [Static Site Gen ### (1) Add deploy Key -1. Generate deploy key `ssh-keygen -t rsa -b 4096 -C "your@email.com" -f gh-pages -N ""` - - You will get 2 files: `gh-pages.pub` (public key) and `gh-pages` (private key) -2. Go to "Settings > Deploy Keys" of repository. -3. Add your public key within "Allow write access" option. -4. Go to "Settings > Secrets" of repository. -5. Add your private key as `ACTIONS_DEPLOY_KEY` +Generate deploy key with the following command. + +```sh +ssh-keygen -t rsa -b 4096 -C "your@email.com" -f gh-pages -N "" + +# You will get 2 files: +# gh-pages.pub (public key) +# gh-pages (private key) +``` + +Next, Go to **Repository Settings** + +- Go to **Deploy Keys** and add your public key with the "Allow write access" +- Go to **Secrets** and add your private key as `ACTIONS_DEPLOY_KEY` ### (2) Create `main.workflow`