From 1cd0ab833d190cc097db56c8eeea2342938bc91e Mon Sep 17 00:00:00 2001 From: prototypa Date: Wed, 10 Aug 2022 16:55:25 -0400 Subject: [PATCH] Add features to README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 032a686..7206e90 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,20 @@ A template to make your website using Astro + Tailwind CSS. > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! +
+ +## 🚀 Features + +- Excellent integration with Tailwind CSS via [@astrojs/tailwind](https://docs.astro.build/en/guides/integrations-guide/tailwind/) +- Image optimization using [@astrojs/images](https://docs.astro.build/en/guides/integrations-guide/image/) +- Automatically generate the project sitemap with [@astrojs/sitemap](https://docs.astro.build/en/guides/integrations-guide/sitemap/) +- Optimize the use of fonts from Google Fonts in post build using [subfont](https://www.npmjs.com/package/subfont) npm package +- Excellent score in Google Chrome Lighthouse report (build code): **100 Performance**, **100 Accessibility**, **100 Best Practices**, **100 SEO** +- Production ready PageSpeed Insights: [Test pagespeed for Astrowind Demo](https://pagespeed.web.dev/report?url=https%3A%2F%2Fastrowind.vercel.app%2F) + + +
+ ## 🚀 Project Structure Inside AstroWind template, you'll see the following folders and files: @@ -35,6 +49,8 @@ There's nothing special about `src/components/`, but that's where we like to put Any static assets, like images, can be placed in the `public/` directory. +
+ ## 🧞 Commands All commands are run from the root of the project, from a terminal: @@ -46,6 +62,8 @@ All commands are run from the root of the project, from a terminal: | `npm run build` | Build your production site to `./dist/` | | `npm run preview` | Preview your build locally, before deploying | +
+ ## 👀 Want to learn more? Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).