diff --git a/README.md b/README.md index 3ff5923..6971ceb 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ # gallery.badmanners.xyz +Static website built in Astro + Typescript + TailwindCSS. + ## Development +### Setup + +```bash +git clone https://git.badmanners.xyz/badmanners/gallery.badmanners.xyz +cd git.badmanners.xyz +npm install +``` + +### Local development + +```bash +npm run dev # Start development server (quit with Ctrl-C) +npm run astro -- sync # Rebuild types from src/content/ files +npm run prettier # Prettier formatting +``` + ### Export story for upload ```bash -npm run export-story -- --output-dir ~/Documents/TO_UPLOAD slug-for-selected-story +npm run export-story -- --output-dir ~/Documents/TO_UPLOAD slug-for-story-to-export ``` -## Deployment - -### Remote +### Build and deploy to remote ```bash npm run build diff --git a/package.json b/package.json index d765125..3bc4330 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "gallery-badmanners-xyz", "type": "module", - "version": "0.0.1", + "version": "1.0.0", "scripts": { "dev": "astro dev", "start": "astro dev",