Skip to content

Commit

Permalink
docs: add missing example
Browse files Browse the repository at this point in the history
  • Loading branch information
bcomnes committed Feb 18, 2020
1 parent 60d959d commit 3024afb
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Expand Up @@ -21,6 +21,38 @@ This `dist_dir` should be specified as the `distDir` input. Once the build is c

You most likely only want to run this on the `master` branch so that only changes commited to `master` result in website updates.

### Example workflow

```yaml
name: Deploy to neociteis

on:
push:
branches:
- master

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
- name: Use Node.js
uses: actions/setup-node@v1
with:
node-version: 12
- name: Install deps and build
run: |
npm i
npm run build
- name: Deploy to neocities
uses: bcomnes/deploy-to-neocities@v1
with:
api_token: ${{ secrets.NEOCITIES_API_TOKEN }}
cleanup: false
dist_dir: public
```

### Inputs

- `api_token` (**REQUIRED**): The api token for your [Neocities][nc] website to deploy to.
Expand Down

0 comments on commit 3024afb

Please sign in to comment.