diff options
| author | Aylur <[email protected]> | 2024-09-30 15:18:35 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-09-30 15:18:35 +0200 |
| commit | d463f15201352f8fe884f6dd70bbad87fec23e9e (patch) | |
| tree | c1a0280b61b41056cb061aaad0d43292948c88ee /docs | |
| parent | 5b78a1b761fca17c19ad4656738463139cca264a (diff) | |
docs: update readme
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/README.md b/docs/README.md index a645121..8c37561 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,13 +12,13 @@ Hosted at [aylur.github.io/astal](https://aylur.github.io/astal/) and [aylur.git | `npm run build` | Build your production site to `./dist/` | | `npm run preview` | Preview your build locally | -## Add your creation to the landing page +## Add your creation to the showcases page 1. Add your image as a webp to `public/showcase` -2. Add it to `src/content/showcases.ts` +2. Add it to `showcases/showcases.ts` - `src` should be `/astal/showcase/your-name-optional-title.webp` - - `url` should point to the source code of the showcased widget - - `author` your name + - `url` should point to the source code of the showcased widget/setup + - `author` should be your name/nickname ``` . |