summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--packages/astro/README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/packages/astro/README.md b/packages/astro/README.md
index 6007e27af..204ab6406 100644
--- a/packages/astro/README.md
+++ b/packages/astro/README.md
@@ -1 +1,23 @@
-packages/astro/README.md \ No newline at end of file
+<img src="https://github.com/snowpackjs/astro/blob/main/assets/social/banner.png?raw=true" />
+
+**Astro** is a _fresh but familiar_ approach to building websites. Astro combines decades of proven performance best practices with the DX improvements of the component-oriented era. Use your favorite JavaScript framework and automatically ship the bare-minimum amount of JavaScript—by default.
+
+
+### [Announcement Post →](https://astro.build/blog/introducing-astro)
+
+### [Full Documentation Site →](https://docs.astro.build/)
+
+## Project Status
+
+⚠️ **Astro is still an early beta, missing features and bugs are to be expected!** If you can stomach it, then Astro-built sites are production ready and several production websites built with Astro already exist in the wild. We will update this note once we get closer to a stable, v1.0 release.
+
+## Quick Start
+
+```bash
+# get started with astro in 3 easy steps:
+mkdir new-project-directory
+cd new-project-directory
+npm init astro
+```
+
+### [Full Documentation Site →](https://docs.astro.build/)