From e1ba1c4561be21d5a128eb89f2bf00d6c398d142 Mon Sep 17 00:00:00 2001
From: prototypa <54446028+prototypa@users.noreply.github.com>
Date: Fri, 12 Aug 2022 02:30:54 -0400
Subject: [PATCH] Update README.md
---
README.md | 49 +++++++++++++++++++++++++++++++------------------
1 file changed, 31 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
index ffa892d..c5ce012 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,28 @@
-# AstroWind
+# AstroWind Template
-A template to make your website using Astro + Tailwind CSS.
+
-> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
+A template to make your website using **Astro + Tailwind CSS**. Ready to start a new project and designed taking into account best practices
-
+**Features**
-[Live demo](https://astrowind.vercel.app/)
-
-
-
-## 🚀 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/)
+- 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/). Supports resizing images and encoding them to different image formats.
- 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 at build time with [subfont](https://www.npmjs.com/package/subfont) npm package
+- Optimize the use of fonts from Google Fonts at build time with [subfont](https://www.npmjs.com/package/subfont) package
- Excellent score in Chrome Lighthouse reports (build code):
- 100 Performance
- 100 Accessibility
- 100 Best Practices
- 100 SEO
-- Production ready Google PageSpeed Insights
+- Production ready Google PageSpeed Insights score
+
+
+
+
+
+[Live demo](https://astrowind.vercel.app/)
@@ -38,7 +39,7 @@ Inside AstroWind template, you'll see the following folders and files:
│ ├── assets/
│ │ ├── images/
| | | └── ...
-| | └── styles
+| | └── styles/
| | └── base.css
│ ├── components/
│ │ ├── astro/
@@ -51,7 +52,8 @@ Inside AstroWind template, you'll see the following folders and files:
│ ├── layouts/
│ | └── Layout.astro
│ └── pages/
-│ └── index.astro
+│ ├── index.astro
+| └── ...
└── package.json
└── ...
```
@@ -62,6 +64,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 if they do not require any transformation or in the assets folder if they are imported directly.
+> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
## 🧞 Commands
@@ -77,6 +81,15 @@ All commands are run from the root of the project, from a terminal:
-## 👀 Want to learn more?
+## ⏳ Roadmap
-Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
+- **Add blog**: Support for accessible, fast and SEO friendly blog
+- **Documentation**: Create detailed documentation with best practices and redesign tips
+- **More components**: Add more Tailwind components useful for most scenarios (Features, Contact, Call to Actions, Content, FAQs ...)
+- **More Examples**: Add commonly used example pages (Ex: About, Terms, Services...)
+
+
+
+## 👀 Want more?
+
+If you have any suggestions or find any bugs, feel free to open an issue or a pull request.